Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-devtestlabs

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

ArmTemplatesGetResponse

ArmTemplatesGetResponse: ArmTemplate & object

Contains response data for the get operation.

ArmTemplatesListNextResponse

ArmTemplatesListNextResponse: ArmTemplateList & object

Contains response data for the listNext operation.

ArmTemplatesListResponse

ArmTemplatesListResponse: ArmTemplateList & object

Contains response data for the list operation.

ArtifactSourcesCreateOrUpdateResponse

ArtifactSourcesCreateOrUpdateResponse: ArtifactSource & object

Contains response data for the createOrUpdate operation.

ArtifactSourcesGetResponse

ArtifactSourcesGetResponse: ArtifactSource & object

Contains response data for the get operation.

ArtifactSourcesListNextResponse

ArtifactSourcesListNextResponse: ArtifactSourceList & object

Contains response data for the listNext operation.

ArtifactSourcesListResponse

ArtifactSourcesListResponse: ArtifactSourceList & object

Contains response data for the list operation.

ArtifactSourcesUpdateResponse

ArtifactSourcesUpdateResponse: ArtifactSource & object

Contains response data for the update operation.

ArtifactsGenerateArmTemplateResponse

ArtifactsGenerateArmTemplateResponse: ArmTemplateInfo & object

Contains response data for the generateArmTemplate operation.

ArtifactsGetResponse

ArtifactsGetResponse: Artifact & object

Contains response data for the get operation.

ArtifactsListNextResponse

ArtifactsListNextResponse: ArtifactList & object

Contains response data for the listNext operation.

ArtifactsListResponse

ArtifactsListResponse: ArtifactList & object

Contains response data for the list operation.

CostThresholdStatus

CostThresholdStatus: "Enabled" | "Disabled"

Defines values for CostThresholdStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

CostType

CostType: "Unavailable" | "Reported" | "Projected"

Defines values for CostType. Possible values include: 'Unavailable', 'Reported', 'Projected'

readonly
enum

{string}

CostsCreateOrUpdateResponse

CostsCreateOrUpdateResponse: LabCost & object

Contains response data for the createOrUpdate operation.

CostsGetResponse

CostsGetResponse: LabCost & object

Contains response data for the get operation.

CustomImageOsType

CustomImageOsType: "Windows" | "Linux" | "None"

Defines values for CustomImageOsType. Possible values include: 'Windows', 'Linux', 'None'

readonly
enum

{string}

CustomImagesBeginCreateOrUpdateResponse

CustomImagesBeginCreateOrUpdateResponse: CustomImage & object

Contains response data for the beginCreateOrUpdate operation.

CustomImagesCreateOrUpdateResponse

CustomImagesCreateOrUpdateResponse: CustomImage & object

Contains response data for the createOrUpdate operation.

CustomImagesGetResponse

CustomImagesGetResponse: CustomImage & object

Contains response data for the get operation.

CustomImagesListNextResponse

CustomImagesListNextResponse: CustomImageList & object

Contains response data for the listNext operation.

CustomImagesListResponse

CustomImagesListResponse: CustomImageList & object

Contains response data for the list operation.

CustomImagesUpdateResponse

CustomImagesUpdateResponse: CustomImage & object

Contains response data for the update operation.

DisksBeginCreateOrUpdateResponse

DisksBeginCreateOrUpdateResponse: Disk & object

Contains response data for the beginCreateOrUpdate operation.

DisksCreateOrUpdateResponse

DisksCreateOrUpdateResponse: Disk & object

Contains response data for the createOrUpdate operation.

DisksGetResponse

DisksGetResponse: Disk & object

Contains response data for the get operation.

DisksListNextResponse

DisksListNextResponse: DiskList & object

Contains response data for the listNext operation.

DisksListResponse

DisksListResponse: DiskList & object

Contains response data for the list operation.

DisksUpdateResponse

DisksUpdateResponse: Disk & object

Contains response data for the update operation.

EnableStatus

EnableStatus: "Enabled" | "Disabled"

Defines values for EnableStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

EnvironmentPermission

EnvironmentPermission: "Reader" | "Contributor"

Defines values for EnvironmentPermission. Possible values include: 'Reader', 'Contributor'

readonly
enum

{string}

EnvironmentsBeginCreateOrUpdateResponse

EnvironmentsBeginCreateOrUpdateResponse: DtlEnvironment & object

Contains response data for the beginCreateOrUpdate operation.

EnvironmentsCreateOrUpdateResponse

EnvironmentsCreateOrUpdateResponse: DtlEnvironment & object

Contains response data for the createOrUpdate operation.

EnvironmentsGetResponse

EnvironmentsGetResponse: DtlEnvironment & object

Contains response data for the get operation.

EnvironmentsListNextResponse

EnvironmentsListNextResponse: DtlEnvironmentList & object

Contains response data for the listNext operation.

EnvironmentsListResponse

EnvironmentsListResponse: DtlEnvironmentList & object

Contains response data for the list operation.

EnvironmentsUpdateResponse

EnvironmentsUpdateResponse: DtlEnvironment & object

Contains response data for the update operation.

FileUploadOptions

FileUploadOptions: "UploadFilesAndGenerateSasTokens" | "None"

Defines values for FileUploadOptions. Possible values include: 'UploadFilesAndGenerateSasTokens', 'None'

readonly
enum

{string}

FormulasBeginCreateOrUpdateResponse

FormulasBeginCreateOrUpdateResponse: Formula & object

Contains response data for the beginCreateOrUpdate operation.

FormulasCreateOrUpdateResponse

FormulasCreateOrUpdateResponse: Formula & object

Contains response data for the createOrUpdate operation.

FormulasGetResponse

FormulasGetResponse: Formula & object

Contains response data for the get operation.

FormulasListNextResponse

FormulasListNextResponse: FormulaList & object

Contains response data for the listNext operation.

FormulasListResponse

FormulasListResponse: FormulaList & object

Contains response data for the list operation.

FormulasUpdateResponse

FormulasUpdateResponse: Formula & object

Contains response data for the update operation.

GalleryImagesListNextResponse

GalleryImagesListNextResponse: GalleryImageList & object

Contains response data for the listNext operation.

GalleryImagesListResponse

GalleryImagesListResponse: GalleryImageList & object

Contains response data for the list operation.

GlobalSchedulesCreateOrUpdateResponse

GlobalSchedulesCreateOrUpdateResponse: Schedule & object

Contains response data for the createOrUpdate operation.

GlobalSchedulesGetResponse

GlobalSchedulesGetResponse: Schedule & object

Contains response data for the get operation.

GlobalSchedulesListByResourceGroupNextResponse

GlobalSchedulesListByResourceGroupNextResponse: ScheduleList & object

Contains response data for the listByResourceGroupNext operation.

GlobalSchedulesListByResourceGroupResponse

GlobalSchedulesListByResourceGroupResponse: ScheduleList & object

Contains response data for the listByResourceGroup operation.

GlobalSchedulesListBySubscriptionNextResponse

GlobalSchedulesListBySubscriptionNextResponse: ScheduleList & object

Contains response data for the listBySubscriptionNext operation.

GlobalSchedulesListBySubscriptionResponse

GlobalSchedulesListBySubscriptionResponse: ScheduleList & object

Contains response data for the listBySubscription operation.

GlobalSchedulesUpdateResponse

GlobalSchedulesUpdateResponse: Schedule & object

Contains response data for the update operation.

HostCachingOptions

HostCachingOptions: "None" | "ReadOnly" | "ReadWrite"

Defines values for HostCachingOptions. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

readonly
enum

{string}

HttpStatusCode

HttpStatusCode: "Continue" | "SwitchingProtocols" | "OK" | "Created" | "Accepted" | "NonAuthoritativeInformation" | "NoContent" | "ResetContent" | "PartialContent" | "MultipleChoices" | "MovedPermanently" | "Redirect" | "SeeOther" | "NotModified" | "UseProxy" | "Unused" | "TemporaryRedirect" | "BadRequest" | "Unauthorized" | "PaymentRequired" | "Forbidden" | "NotFound" | "MethodNotAllowed" | "NotAcceptable" | "ProxyAuthenticationRequired" | "RequestTimeout" | "Conflict" | "Gone" | "LengthRequired" | "PreconditionFailed" | "RequestEntityTooLarge" | "RequestUriTooLong" | "UnsupportedMediaType" | "RequestedRangeNotSatisfiable" | "ExpectationFailed" | "UpgradeRequired" | "InternalServerError" | "NotImplemented" | "BadGateway" | "ServiceUnavailable" | "GatewayTimeout" | "HttpVersionNotSupported"

Defines values for HttpStatusCode. Possible values include: 'Continue', 'SwitchingProtocols', 'OK', 'Created', 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', 'PartialContent', 'MultipleChoices', 'MovedPermanently', 'Redirect', 'SeeOther', 'NotModified', 'UseProxy', 'Unused', 'TemporaryRedirect', 'BadRequest', 'Unauthorized', 'PaymentRequired', 'Forbidden', 'NotFound', 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', 'PreconditionFailed', 'RequestEntityTooLarge', 'RequestUriTooLong', 'UnsupportedMediaType', 'RequestedRangeNotSatisfiable', 'ExpectationFailed', 'UpgradeRequired', 'InternalServerError', 'NotImplemented', 'BadGateway', 'ServiceUnavailable', 'GatewayTimeout', 'HttpVersionNotSupported'

readonly
enum

{string}

LabsBeginCreateOrUpdateResponse

LabsBeginCreateOrUpdateResponse: Lab & object

Contains response data for the beginCreateOrUpdate operation.

LabsCreateOrUpdateResponse

LabsCreateOrUpdateResponse: Lab & object

Contains response data for the createOrUpdate operation.

LabsGenerateUploadUriResponse

LabsGenerateUploadUriResponse: GenerateUploadUriResponse & object

Contains response data for the generateUploadUri operation.

LabsGetResponse

LabsGetResponse: Lab & object

Contains response data for the get operation.

LabsListByResourceGroupNextResponse

LabsListByResourceGroupNextResponse: LabList & object

Contains response data for the listByResourceGroupNext operation.

LabsListByResourceGroupResponse

LabsListByResourceGroupResponse: LabList & object

Contains response data for the listByResourceGroup operation.

LabsListBySubscriptionNextResponse

LabsListBySubscriptionNextResponse: LabList & object

Contains response data for the listBySubscriptionNext operation.

LabsListBySubscriptionResponse

LabsListBySubscriptionResponse: LabList & object

Contains response data for the listBySubscription operation.

LabsListVhdsNextResponse

LabsListVhdsNextResponse: LabVhdList & object

Contains response data for the listVhdsNext operation.

LabsListVhdsResponse

LabsListVhdsResponse: LabVhdList & object

Contains response data for the listVhds operation.

LabsUpdateResponse

LabsUpdateResponse: Lab & object

Contains response data for the update operation.

LinuxOsState

LinuxOsState: "NonDeprovisioned" | "DeprovisionRequested" | "DeprovisionApplied"

Defines values for LinuxOsState. Possible values include: 'NonDeprovisioned', 'DeprovisionRequested', 'DeprovisionApplied'

readonly
enum

{string}

NotificationChannelEventType

NotificationChannelEventType: "AutoShutdown" | "Cost"

Defines values for NotificationChannelEventType. Possible values include: 'AutoShutdown', 'Cost'

readonly
enum

{string}

NotificationChannelsCreateOrUpdateResponse

NotificationChannelsCreateOrUpdateResponse: NotificationChannel & object

Contains response data for the createOrUpdate operation.

NotificationChannelsGetResponse

NotificationChannelsGetResponse: NotificationChannel & object

Contains response data for the get operation.

NotificationChannelsListNextResponse

NotificationChannelsListNextResponse: NotificationChannelList & object

Contains response data for the listNext operation.

NotificationChannelsListResponse

NotificationChannelsListResponse: NotificationChannelList & object

Contains response data for the list operation.

NotificationChannelsUpdateResponse

NotificationChannelsUpdateResponse: NotificationChannel & object

Contains response data for the update operation.

OperationsGetResponse

OperationsGetResponse: OperationResult & object

Contains response data for the get operation.

PoliciesCreateOrUpdateResponse

PoliciesCreateOrUpdateResponse: Policy & object

Contains response data for the createOrUpdate operation.

PoliciesGetResponse

PoliciesGetResponse: Policy & object

Contains response data for the get operation.

PoliciesListNextResponse

PoliciesListNextResponse: PolicyList & object

Contains response data for the listNext operation.

PoliciesListResponse

PoliciesListResponse: PolicyList & object

Contains response data for the list operation.

PoliciesUpdateResponse

PoliciesUpdateResponse: Policy & object

Contains response data for the update operation.

PolicyEvaluatorType

PolicyEvaluatorType: "AllowedValuesPolicy" | "MaxValuePolicy"

Defines values for PolicyEvaluatorType. Possible values include: 'AllowedValuesPolicy', 'MaxValuePolicy'

readonly
enum

{string}

PolicyFactName

PolicyFactName: "UserOwnedLabVmCount" | "UserOwnedLabPremiumVmCount" | "LabVmCount" | "LabPremiumVmCount" | "LabVmSize" | "GalleryImage" | "UserOwnedLabVmCountInSubnet" | "LabTargetCost" | "EnvironmentTemplate" | "ScheduleEditPermission"

Defines values for PolicyFactName. Possible values include: 'UserOwnedLabVmCount', 'UserOwnedLabPremiumVmCount', 'LabVmCount', 'LabPremiumVmCount', 'LabVmSize', 'GalleryImage', 'UserOwnedLabVmCountInSubnet', 'LabTargetCost', 'EnvironmentTemplate', 'ScheduleEditPermission'

readonly
enum

{string}

PolicySetsEvaluatePoliciesResponse

PolicySetsEvaluatePoliciesResponse: EvaluatePoliciesResponse & object

Contains response data for the evaluatePolicies operation.

PolicyStatus

PolicyStatus: "Enabled" | "Disabled"

Defines values for PolicyStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

PremiumDataDisk

PremiumDataDisk: "Disabled" | "Enabled"

Defines values for PremiumDataDisk. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

ProviderOperationsListNextResponse

ProviderOperationsListNextResponse: ProviderOperationResult & object

Contains response data for the listNext operation.

ProviderOperationsListResponse

ProviderOperationsListResponse: ProviderOperationResult & object

Contains response data for the list operation.

ReportingCycleType

ReportingCycleType: "CalendarMonth" | "Custom"

Defines values for ReportingCycleType. Possible values include: 'CalendarMonth', 'Custom'

readonly
enum

{string}

SchedulesCreateOrUpdateResponse

SchedulesCreateOrUpdateResponse: Schedule & object

Contains response data for the createOrUpdate operation.

SchedulesGetResponse

SchedulesGetResponse: Schedule & object

Contains response data for the get operation.

SchedulesListApplicableNextResponse

SchedulesListApplicableNextResponse: ScheduleList & object

Contains response data for the listApplicableNext operation.

SchedulesListApplicableResponse

SchedulesListApplicableResponse: ScheduleList & object

Contains response data for the listApplicable operation.

SchedulesListNextResponse

SchedulesListNextResponse: ScheduleList & object

Contains response data for the listNext operation.

SchedulesListResponse

SchedulesListResponse: ScheduleList & object

Contains response data for the list operation.

SchedulesUpdateResponse

SchedulesUpdateResponse: Schedule & object

Contains response data for the update operation.

SecretsBeginCreateOrUpdateResponse

SecretsBeginCreateOrUpdateResponse: Secret & object

Contains response data for the beginCreateOrUpdate operation.

SecretsCreateOrUpdateResponse

SecretsCreateOrUpdateResponse: Secret & object

Contains response data for the createOrUpdate operation.

SecretsGetResponse

SecretsGetResponse: Secret & object

Contains response data for the get operation.

SecretsListNextResponse

SecretsListNextResponse: SecretList & object

Contains response data for the listNext operation.

SecretsListResponse

SecretsListResponse: SecretList & object

Contains response data for the list operation.

SecretsUpdateResponse

SecretsUpdateResponse: Secret & object

Contains response data for the update operation.

ServiceFabricSchedulesCreateOrUpdateResponse

ServiceFabricSchedulesCreateOrUpdateResponse: Schedule & object

Contains response data for the createOrUpdate operation.

ServiceFabricSchedulesGetResponse

ServiceFabricSchedulesGetResponse: Schedule & object

Contains response data for the get operation.

ServiceFabricSchedulesListNextResponse

ServiceFabricSchedulesListNextResponse: ScheduleList & object

Contains response data for the listNext operation.

ServiceFabricSchedulesListResponse

ServiceFabricSchedulesListResponse: ScheduleList & object

Contains response data for the list operation.

ServiceFabricSchedulesUpdateResponse

ServiceFabricSchedulesUpdateResponse: Schedule & object

Contains response data for the update operation.

ServiceFabricsBeginCreateOrUpdateResponse

ServiceFabricsBeginCreateOrUpdateResponse: ServiceFabric & object

Contains response data for the beginCreateOrUpdate operation.

ServiceFabricsCreateOrUpdateResponse

ServiceFabricsCreateOrUpdateResponse: ServiceFabric & object

Contains response data for the createOrUpdate operation.

ServiceFabricsGetResponse

ServiceFabricsGetResponse: ServiceFabric & object

Contains response data for the get operation.

ServiceFabricsListApplicableSchedulesResponse

ServiceFabricsListApplicableSchedulesResponse: ApplicableSchedule & object

Contains response data for the listApplicableSchedules operation.

ServiceFabricsListNextResponse

ServiceFabricsListNextResponse: ServiceFabricList & object

Contains response data for the listNext operation.

ServiceFabricsListResponse

ServiceFabricsListResponse: ServiceFabricList & object

Contains response data for the list operation.

ServiceFabricsUpdateResponse

ServiceFabricsUpdateResponse: ServiceFabric & object

Contains response data for the update operation.

ServiceRunnersCreateOrUpdateResponse

ServiceRunnersCreateOrUpdateResponse: ServiceRunner & object

Contains response data for the createOrUpdate operation.

ServiceRunnersGetResponse

ServiceRunnersGetResponse: ServiceRunner & object

Contains response data for the get operation.

ServiceRunnersListNextResponse

ServiceRunnersListNextResponse: ServiceRunnerList & object

Contains response data for the listNext operation.

ServiceRunnersListResponse

ServiceRunnersListResponse: ServiceRunnerList & object

Contains response data for the list operation.

SourceControlType

SourceControlType: "VsoGit" | "GitHub"

Defines values for SourceControlType. Possible values include: 'VsoGit', 'GitHub'

readonly
enum

{string}

StorageType

StorageType: "Standard" | "Premium"

Defines values for StorageType. Possible values include: 'Standard', 'Premium'

readonly
enum

{string}

TargetCostStatus

TargetCostStatus: "Enabled" | "Disabled"

Defines values for TargetCostStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

TransportProtocol

TransportProtocol: "Tcp" | "Udp"

Defines values for TransportProtocol. Possible values include: 'Tcp', 'Udp'

readonly
enum

{string}

UsagePermissionType

UsagePermissionType: "Default" | "Deny" | "Allow"

Defines values for UsagePermissionType. Possible values include: 'Default', 'Deny', 'Allow'

readonly
enum

{string}

UsersBeginCreateOrUpdateResponse

UsersBeginCreateOrUpdateResponse: User & object

Contains response data for the beginCreateOrUpdate operation.

UsersCreateOrUpdateResponse

UsersCreateOrUpdateResponse: User & object

Contains response data for the createOrUpdate operation.

UsersGetResponse

UsersGetResponse: User & object

Contains response data for the get operation.

UsersListNextResponse

UsersListNextResponse: UserList & object

Contains response data for the listNext operation.

UsersListResponse

UsersListResponse: UserList & object

Contains response data for the list operation.

UsersUpdateResponse

UsersUpdateResponse: User & object

Contains response data for the update operation.

VirtualMachineCreationSource

VirtualMachineCreationSource: "FromCustomImage" | "FromGalleryImage"

Defines values for VirtualMachineCreationSource. Possible values include: 'FromCustomImage', 'FromGalleryImage'

readonly
enum

{string}

VirtualMachineSchedulesCreateOrUpdateResponse

VirtualMachineSchedulesCreateOrUpdateResponse: Schedule & object

Contains response data for the createOrUpdate operation.

VirtualMachineSchedulesGetResponse

VirtualMachineSchedulesGetResponse: Schedule & object

Contains response data for the get operation.

VirtualMachineSchedulesListNextResponse

VirtualMachineSchedulesListNextResponse: ScheduleList & object

Contains response data for the listNext operation.

VirtualMachineSchedulesListResponse

VirtualMachineSchedulesListResponse: ScheduleList & object

Contains response data for the list operation.

VirtualMachineSchedulesUpdateResponse

VirtualMachineSchedulesUpdateResponse: Schedule & object

Contains response data for the update operation.

VirtualMachinesBeginCreateOrUpdateResponse

VirtualMachinesBeginCreateOrUpdateResponse: LabVirtualMachine & object

Contains response data for the beginCreateOrUpdate operation.

VirtualMachinesCreateOrUpdateResponse

VirtualMachinesCreateOrUpdateResponse: LabVirtualMachine & object

Contains response data for the createOrUpdate operation.

VirtualMachinesGetRdpFileContentsResponse

VirtualMachinesGetRdpFileContentsResponse: RdpConnection & object

Contains response data for the getRdpFileContents operation.

VirtualMachinesGetResponse

VirtualMachinesGetResponse: LabVirtualMachine & object

Contains response data for the get operation.

VirtualMachinesListApplicableSchedulesResponse

VirtualMachinesListApplicableSchedulesResponse: ApplicableSchedule & object

Contains response data for the listApplicableSchedules operation.

VirtualMachinesListNextResponse

VirtualMachinesListNextResponse: LabVirtualMachineList & object

Contains response data for the listNext operation.

VirtualMachinesListResponse

VirtualMachinesListResponse: LabVirtualMachineList & object

Contains response data for the list operation.

VirtualMachinesUpdateResponse

VirtualMachinesUpdateResponse: LabVirtualMachine & object

Contains response data for the update operation.

VirtualNetworksBeginCreateOrUpdateResponse

VirtualNetworksBeginCreateOrUpdateResponse: VirtualNetwork & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworksCreateOrUpdateResponse

VirtualNetworksCreateOrUpdateResponse: VirtualNetwork & object

Contains response data for the createOrUpdate operation.

VirtualNetworksGetResponse

VirtualNetworksGetResponse: VirtualNetwork & object

Contains response data for the get operation.

VirtualNetworksListNextResponse

VirtualNetworksListNextResponse: VirtualNetworkList & object

Contains response data for the listNext operation.

VirtualNetworksListResponse

VirtualNetworksListResponse: VirtualNetworkList & object

Contains response data for the list operation.

VirtualNetworksUpdateResponse

VirtualNetworksUpdateResponse: VirtualNetwork & object

Contains response data for the update operation.

WindowsOsState

WindowsOsState: "NonSysprepped" | "SysprepRequested" | "SysprepApplied"

Defines values for WindowsOsState. Possible values include: 'NonSysprepped', 'SysprepRequested', 'SysprepApplied'

readonly
enum

{string}

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const ApplicableSchedule

ApplicableSchedule: object

Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional labVmsShutdown

labVmsShutdown: Schedule

The auto-shutdown schedule, if one has been set at the lab or lab resource level.

Optional labVmsStartup

labVmsStartup: Schedule

The auto-startup schedule, if one has been set at the lab or lab resource level.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "ApplicableSchedule"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ApplicableSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

labVmsShutdown

labVmsShutdown: object

serializedName

serializedName: string = "properties.labVmsShutdown"

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

labVmsStartup

labVmsStartup: object

serializedName

serializedName: string = "properties.labVmsStartup"

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

Const ApplicableScheduleFragment

ApplicableScheduleFragment: object

Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.

Optional labVmsShutdown

labVmsShutdown: ScheduleFragment

The auto-shutdown schedule, if one has been set at the lab or lab resource level.

Optional labVmsStartup

labVmsStartup: ScheduleFragment

The auto-startup schedule, if one has been set at the lab or lab resource level.

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "ApplicableScheduleFragment"

type

type: object

className

className: string = "ApplicableScheduleFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

labVmsShutdown

labVmsShutdown: object

serializedName

serializedName: string = "properties.labVmsShutdown"

type

type: object

className

className: string = "ScheduleFragment"

name

name: "Composite" = "Composite"

labVmsStartup

labVmsStartup: object

serializedName

serializedName: string = "properties.labVmsStartup"

type

type: object

className

className: string = "ScheduleFragment"

name

name: "Composite" = "Composite"

Const ApplyArtifactsRequest

ApplyArtifactsRequest: object

Request body for applying artifacts to a virtual machine.

Optional artifacts

The list of artifacts to apply.

serializedName

serializedName: string = "ApplyArtifactsRequest"

type

type: object

className

className: string = "ApplyArtifactsRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

artifacts

artifacts: object

serializedName

serializedName: string = "artifacts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactInstallProperties"

name

name: "Composite" = "Composite"

Const ArmTemplate

ArmTemplate: object

An Azure Resource Manager template.

Optional contents

contents: any

The contents of the ARM template. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdDate

createdDate: Date

The creation date of the armTemplate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

The description of the ARM template. NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

The display name of the ARM template. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enabled

enabled: undefined | false | true

Whether or not ARM template is enabled for use by lab user. NOTE: This property will not be serialized. It can only be populated by the server.

Optional icon

icon: undefined | string

The URI to the icon of the ARM template. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parametersValueFilesInfo

parametersValueFilesInfo: ParametersValueFileInfo[]

File name and parameter values information from all azuredeploy..parameters.json for the ARM template. *NOTE: This property will not be serialized. It can only be populated by the server.**

Optional publisher

publisher: undefined | string

The publisher of the ARM template. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "ArmTemplate"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ArmTemplate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contents

contents: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.contents"

type

type: object

name

name: "Object" = "Object"

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

icon

icon: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.icon"

type

type: object

name

name: "String" = "String"

parametersValueFilesInfo

parametersValueFilesInfo: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.parametersValueFilesInfo"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParametersValueFileInfo"

name

name: "Composite" = "Composite"

publisher

publisher: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.publisher"

type

type: object

name

name: "String" = "String"

Const ArmTemplateInfo

ArmTemplateInfo: object

Information about a generated ARM template.

Optional parameters

parameters: any

The parameters of the ARM template.

Optional template

template: any

The template's contents.

serializedName

serializedName: string = "ArmTemplateInfo"

type

type: object

className

className: string = "ArmTemplateInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Object" = "Object"

template

template: object

serializedName

serializedName: string = "template"

type

type: object

name

name: "Object" = "Object"

Const ArmTemplateList

ArmTemplateList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "ArmTemplateList"

__@iterator

  • Iterator

    Returns IterableIterator<ArmTemplate>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ArmTemplate>[]

      Additional items to add to the end of array1.

    Returns ArmTemplate[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ArmTemplate[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ArmTemplate]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ArmTemplate, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ArmTemplate

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ArmTemplate[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ArmTemplate[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ArmTemplate | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ArmTemplate | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ArmTemplate, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ArmTemplate

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ArmTemplate, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ArmTemplate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ArmTemplate, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ArmTemplate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ArmTemplate | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ArmTemplate[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ArmTemplate

  • Parameters

    Returns ArmTemplate

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ArmTemplate
  • reduceRight(callbackfn: function, initialValue: ArmTemplate): ArmTemplate
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ArmTemplate

  • Parameters

    Returns ArmTemplate

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ArmTemplate[]

shift

  • Removes the first element from an array and returns it.

    Returns ArmTemplate | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ArmTemplate[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ArmTemplate[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ArmTemplate[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ArmTemplate[]

      Elements to insert into the array in place of the deleted elements.

    Returns ArmTemplate[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ArmTemplate[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ArmTemplate>

type

type: object

className

className: string = "ArmTemplateList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArmTemplate"

name

name: "Composite" = "Composite"

Const ArmTemplateParameterProperties

ArmTemplateParameterProperties: object

Properties of an Azure Resource Manager template parameter.

Optional name

name: undefined | string

The name of the template parameter.

Optional value

value: undefined | string

The value of the template parameter.

serializedName

serializedName: string = "ArmTemplateParameterProperties"

type

type: object

className

className: string = "ArmTemplateParameterProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ArmTemplateParameterPropertiesFragment

ArmTemplateParameterPropertiesFragment: object

Properties of an Azure Resource Manager template parameter.

Optional name

name: undefined | string

The name of the template parameter.

Optional value

value: undefined | string

The value of the template parameter.

serializedName

serializedName: string = "ArmTemplateParameterPropertiesFragment"

type

type: object

className

className: string = "ArmTemplateParameterPropertiesFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const Artifact

Artifact: object

An artifact.

Optional createdDate

createdDate: Date

The artifact's creation date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

The artifact's description. NOTE: This property will not be serialized. It can only be populated by the server.

Optional filePath

filePath: undefined | string

The file path to the artifact. NOTE: This property will not be serialized. It can only be populated by the server.

Optional icon

icon: undefined | string

The URI to the artifact icon. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: any

The artifact's parameters. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publisher

publisher: undefined | string

The artifact's publisher. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

Optional targetOsType

targetOsType: undefined | string

The artifact's target OS. NOTE: This property will not be serialized. It can only be populated by the server.

Optional title

title: undefined | string

The artifact's title. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Artifact"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Artifact"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

filePath

filePath: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.filePath"

type

type: object

name

name: "String" = "String"

icon

icon: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.icon"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Object" = "Object"

publisher

publisher: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.publisher"

type

type: object

name

name: "String" = "String"

targetOsType

targetOsType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.targetOsType"

type

type: object

name

name: "String" = "String"

title

title: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.title"

type

type: object

name

name: "String" = "String"

Const ArtifactDeploymentStatusProperties

ArtifactDeploymentStatusProperties: object

Properties of an artifact deployment.

Optional artifactsApplied

artifactsApplied: undefined | number

The total count of the artifacts that were successfully applied.

Optional deploymentStatus

deploymentStatus: undefined | string

The deployment status of the artifact.

Optional totalArtifacts

totalArtifacts: undefined | number

The total count of the artifacts that were tentatively applied.

serializedName

serializedName: string = "ArtifactDeploymentStatusProperties"

type

type: object

className

className: string = "ArtifactDeploymentStatusProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

artifactsApplied

artifactsApplied: object

serializedName

serializedName: string = "artifactsApplied"

type

type: object

name

name: "Number" = "Number"

deploymentStatus

deploymentStatus: object

serializedName

serializedName: string = "deploymentStatus"

type

type: object

name

name: "String" = "String"

totalArtifacts

totalArtifacts: object

serializedName

serializedName: string = "totalArtifacts"

type

type: object

name

name: "Number" = "Number"

Const ArtifactDeploymentStatusPropertiesFragment

ArtifactDeploymentStatusPropertiesFragment: object

Properties of an artifact deployment.

Optional artifactsApplied

artifactsApplied: undefined | number

The total count of the artifacts that were successfully applied.

Optional deploymentStatus

deploymentStatus: undefined | string

The deployment status of the artifact.

Optional totalArtifacts

totalArtifacts: undefined | number

The total count of the artifacts that were tentatively applied.

serializedName

serializedName: string = "ArtifactDeploymentStatusPropertiesFragment"

type

type: object

className

className: string = "ArtifactDeploymentStatusPropertiesFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

artifactsApplied

artifactsApplied: object

serializedName

serializedName: string = "artifactsApplied"

type

type: object

name

name: "Number" = "Number"

deploymentStatus

deploymentStatus: object

serializedName

serializedName: string = "deploymentStatus"

type

type: object

name

name: "String" = "String"

totalArtifacts

totalArtifacts: object

serializedName

serializedName: string = "totalArtifacts"

type

type: object

name

name: "Number" = "Number"

Const ArtifactInstallProperties

ArtifactInstallProperties: object

Properties of an artifact.

Optional artifactId

artifactId: undefined | string

The artifact's identifier.

Optional artifactTitle

artifactTitle: undefined | string

The artifact's title.

Optional deploymentStatusMessage

deploymentStatusMessage: undefined | string

The status message from the deployment.

Optional installTime

installTime: Date

The time that the artifact starts to install on the virtual machine.

Optional parameters

The parameters of the artifact.

Optional status

status: undefined | string

The status of the artifact.

Optional vmExtensionStatusMessage

vmExtensionStatusMessage: undefined | string

The status message from the virtual machine extension.

serializedName

serializedName: string = "ArtifactInstallProperties"

type

type: object

className

className: string = "ArtifactInstallProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

artifactId

artifactId: object

serializedName

serializedName: string = "artifactId"

type

type: object

name

name: "String" = "String"

artifactTitle

artifactTitle: object

serializedName

serializedName: string = "artifactTitle"

type

type: object

name

name: "String" = "String"

deploymentStatusMessage

deploymentStatusMessage: object

serializedName

serializedName: string = "deploymentStatusMessage"

type

type: object

name

name: "String" = "String"

installTime

installTime: object

serializedName

serializedName: string = "installTime"

type

type: object

name

name: "DateTime" = "DateTime"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactParameterProperties"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

vmExtensionStatusMessage

vmExtensionStatusMessage: object

serializedName

serializedName: string = "vmExtensionStatusMessage"

type

type: object

name

name: "String" = "String"

Const ArtifactInstallPropertiesFragment

ArtifactInstallPropertiesFragment: object

Properties of an artifact.

Optional artifactId

artifactId: undefined | string

The artifact's identifier.

Optional artifactTitle

artifactTitle: undefined | string

The artifact's title.

Optional deploymentStatusMessage

deploymentStatusMessage: undefined | string

The status message from the deployment.

Optional installTime

installTime: Date

The time that the artifact starts to install on the virtual machine.

Optional parameters

The parameters of the artifact.

Optional status

status: undefined | string

The status of the artifact.

Optional vmExtensionStatusMessage

vmExtensionStatusMessage: undefined | string

The status message from the virtual machine extension.

serializedName

serializedName: string = "ArtifactInstallPropertiesFragment"

type

type: object

className

className: string = "ArtifactInstallPropertiesFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

artifactId

artifactId: object

serializedName

serializedName: string = "artifactId"

type

type: object

name

name: "String" = "String"

artifactTitle

artifactTitle: object

serializedName

serializedName: string = "artifactTitle"

type

type: object

name

name: "String" = "String"

deploymentStatusMessage

deploymentStatusMessage: object

serializedName

serializedName: string = "deploymentStatusMessage"

type

type: object

name

name: "String" = "String"

installTime

installTime: object

serializedName

serializedName: string = "installTime"

type

type: object

name

name: "DateTime" = "DateTime"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactParameterPropertiesFragment"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

vmExtensionStatusMessage

vmExtensionStatusMessage: object

serializedName

serializedName: string = "vmExtensionStatusMessage"

type

type: object

name

name: "String" = "String"

Const ArtifactList

ArtifactList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "ArtifactList"

__@iterator

  • __@iterator(): IterableIterator<Artifact>
  • Iterator

    Returns IterableIterator<Artifact>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Artifact>[]

      Additional items to add to the end of array1.

    Returns Artifact[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Artifact[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Artifact]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Artifact]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Artifact, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Artifact

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Artifact[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Artifact[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Artifact | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Artifact | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Artifact, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Artifact

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Artifact, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Artifact

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Artifact, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Artifact

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Artifact | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Artifact[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Artifact
  • reduce(callbackfn: function, initialValue: Artifact): Artifact
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Artifact

  • Parameters

    Returns Artifact

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Artifact, currentIndex: number, array: Artifact[]): U
        • Parameters

          • previousValue: U
          • currentValue: Artifact
          • currentIndex: number
          • array: Artifact[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Artifact
  • reduceRight(callbackfn: function, initialValue: Artifact): Artifact
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Artifact

  • Parameters

    Returns Artifact

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Artifact, currentIndex: number, array: Artifact[]): U
        • Parameters

          • previousValue: U
          • currentValue: Artifact
          • currentIndex: number
          • array: Artifact[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Artifact[]

shift

  • Removes the first element from an array and returns it.

    Returns Artifact | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Artifact[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Artifact[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Artifact[]
  • splice(start: number, deleteCount: number, ...items: Artifact[]): Artifact[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Artifact[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Artifact[]

      Elements to insert into the array in place of the deleted elements.

    Returns Artifact[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Artifact[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Artifact>

type

type: object

className

className: string = "ArtifactList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Artifact"

name

name: "Composite" = "Composite"

Const ArtifactParameterProperties

ArtifactParameterProperties: object

Properties of an artifact parameter.

Optional name

name: undefined | string

The name of the artifact parameter.

Optional value

value: undefined | string

The value of the artifact parameter.

serializedName

serializedName: string = "ArtifactParameterProperties"

type

type: object

className

className: string = "ArtifactParameterProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ArtifactParameterPropertiesFragment

ArtifactParameterPropertiesFragment: object

Properties of an artifact parameter.

Optional name

name: undefined | string

The name of the artifact parameter.

Optional value

value: undefined | string

The value of the artifact parameter.

serializedName

serializedName: string = "ArtifactParameterPropertiesFragment"

type

type: object

className

className: string = "ArtifactParameterPropertiesFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ArtifactSource

ArtifactSource: object

Properties of an artifact source.

Optional armTemplateFolderPath

armTemplateFolderPath: undefined | string

The folder containing Azure Resource Manager templates.

Optional branchRef

branchRef: undefined | string

The artifact source's branch reference.

Optional createdDate

createdDate: Date

The artifact source's creation date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

The artifact source's display name.

Optional folderPath

folderPath: undefined | string

The folder containing artifacts.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional securityToken

securityToken: undefined | string

The security token to authenticate to the artifact source.

Optional sourceType

sourceType: SourceControlType

The artifact source's type. Possible values include: 'VsoGit', 'GitHub'

Optional status

status: EnableStatus

Indicates if the artifact source is enabled (values: Enabled, Disabled). Possible values include: 'Enabled', 'Disabled'

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

Optional uri

uri: undefined | string

The artifact source's URI.

serializedName

serializedName: string = "ArtifactSource"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ArtifactSource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

armTemplateFolderPath

armTemplateFolderPath: object

serializedName

serializedName: string = "properties.armTemplateFolderPath"

type

type: object

name

name: "String" = "String"

branchRef

branchRef: object

serializedName

serializedName: string = "properties.branchRef"

type

type: object

name

name: "String" = "String"

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

folderPath

folderPath: object

serializedName

serializedName: string = "properties.folderPath"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

securityToken

securityToken: object

serializedName

serializedName: string = "properties.securityToken"

type

type: object

name

name: "String" = "String"

sourceType

sourceType: object

serializedName

serializedName: string = "properties.sourceType"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

uri

uri: object

serializedName

serializedName: string = "properties.uri"

type

type: object

name

name: "String" = "String"

Const ArtifactSourceFragment

ArtifactSourceFragment: object

Properties of an artifact source.

Optional armTemplateFolderPath

armTemplateFolderPath: undefined | string

The folder containing Azure Resource Manager templates.

Optional branchRef

branchRef: undefined | string

The artifact source's branch reference.

Optional displayName

displayName: undefined | string

The artifact source's display name.

Optional folderPath

folderPath: undefined | string

The folder containing artifacts.

Optional securityToken

securityToken: undefined | string

The security token to authenticate to the artifact source.

Optional sourceType

sourceType: SourceControlType

The artifact source's type. Possible values include: 'VsoGit', 'GitHub'

Optional status

status: EnableStatus

Indicates if the artifact source is enabled (values: Enabled, Disabled). Possible values include: 'Enabled', 'Disabled'

Optional tags

tags: undefined | object

The tags of the resource.

Optional uri

uri: undefined | string

The artifact source's URI.

serializedName

serializedName: string = "ArtifactSourceFragment"

type

type: object

className

className: string = "ArtifactSourceFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

armTemplateFolderPath

armTemplateFolderPath: object

serializedName

serializedName: string = "properties.armTemplateFolderPath"

type

type: object

name

name: "String" = "String"

branchRef

branchRef: object

serializedName

serializedName: string = "properties.branchRef"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

folderPath

folderPath: object

serializedName

serializedName: string = "properties.folderPath"

type

type: object

name

name: "String" = "String"

securityToken

securityToken: object

serializedName

serializedName: string = "properties.securityToken"

type

type: object

name

name: "String" = "String"

sourceType

sourceType: object

serializedName

serializedName: string = "properties.sourceType"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

uri

uri: object

serializedName

serializedName: string = "properties.uri"

type

type: object

name

name: "String" = "String"

Const ArtifactSourceList

ArtifactSourceList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "ArtifactSourceList"

__@iterator

  • Iterator

    Returns IterableIterator<ArtifactSource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ArtifactSource>[]

      Additional items to add to the end of array1.

    Returns ArtifactSource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ArtifactSource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ArtifactSource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ArtifactSource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ArtifactSource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ArtifactSource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ArtifactSource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ArtifactSource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ArtifactSource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ArtifactSource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ArtifactSource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ArtifactSource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ArtifactSource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ArtifactSource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ArtifactSource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ArtifactSource | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ArtifactSource

  • Parameters

    Returns ArtifactSource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ArtifactSource

  • Parameters

    Returns ArtifactSource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ArtifactSource[]

shift

  • Removes the first element from an array and returns it.

    Returns ArtifactSource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ArtifactSource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ArtifactSource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ArtifactSource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ArtifactSource[]

      Elements to insert into the array in place of the deleted elements.

    Returns ArtifactSource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ArtifactSource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ArtifactSource>

type

type: object

className

className: string = "ArtifactSourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactSource"

name

name: "Composite" = "Composite"

Const AttachDiskProperties

AttachDiskProperties: object

Properties of the disk to attach.

Optional leasedByLabVmId

leasedByLabVmId: undefined | string

The resource ID of the Lab virtual machine to which the disk is attached.

serializedName

serializedName: string = "AttachDiskProperties"

type

type: object

className

className: string = "AttachDiskProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

leasedByLabVmId

leasedByLabVmId: object

serializedName

serializedName: string = "leasedByLabVmId"

type

type: object

name

name: "String" = "String"

Const AttachNewDataDiskOptions

AttachNewDataDiskOptions: object

Properties to attach new disk to the Virtual Machine.

Optional diskName

diskName: undefined | string

The name of the disk to be attached.

Optional diskSizeGiB

diskSizeGiB: undefined | number

Size of the disk to be attached in Gibibytes.

Optional diskType

diskType: StorageType

The storage type for the disk (i.e. Standard, Premium). Possible values include: 'Standard', 'Premium'

serializedName

serializedName: string = "AttachNewDataDiskOptions"

type

type: object

className

className: string = "AttachNewDataDiskOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskName

diskName: object

serializedName

serializedName: string = "diskName"

type

type: object

name

name: "String" = "String"

diskSizeGiB

diskSizeGiB: object

serializedName

serializedName: string = "diskSizeGiB"

type

type: object

name

name: "Number" = "Number"

diskType

diskType: object

serializedName

serializedName: string = "diskType"

type

type: object

name

name: "String" = "String"

Const AttachNewDataDiskOptionsFragment

AttachNewDataDiskOptionsFragment: object

Properties to attach new disk to the Virtual Machine.

Optional diskName

diskName: undefined | string

The name of the disk to be attached.

Optional diskSizeGiB

diskSizeGiB: undefined | number

Size of the disk to be attached in Gibibytes.

Optional diskType

diskType: StorageType

The storage type for the disk (i.e. Standard, Premium). Possible values include: 'Standard', 'Premium'

serializedName

serializedName: string = "AttachNewDataDiskOptionsFragment"

type

type: object

className

className: string = "AttachNewDataDiskOptionsFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskName

diskName: object

serializedName

serializedName: string = "diskName"

type

type: object

name

name: "String" = "String"

diskSizeGiB

diskSizeGiB: object

serializedName

serializedName: string = "diskSizeGiB"

type

type: object

name

name: "Number" = "Number"

diskType

diskType: object

serializedName

serializedName: string = "diskType"

type

type: object

name

name: "String" = "String"

Const BulkCreationParameters

BulkCreationParameters: object

Parameters for creating multiple virtual machines as a single action.

Optional instanceCount

instanceCount: undefined | number

The number of virtual machine instances to create.

serializedName

serializedName: string = "BulkCreationParameters"

type

type: object

className

className: string = "BulkCreationParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

instanceCount

instanceCount: object

serializedName

serializedName: string = "instanceCount"

type

type: object

name

name: "Number" = "Number"

Const BulkCreationParametersFragment

BulkCreationParametersFragment: object

Parameters for creating multiple virtual machines as a single action.

Optional instanceCount

instanceCount: undefined | number

The number of virtual machine instances to create.

serializedName

serializedName: string = "BulkCreationParametersFragment"

type

type: object

className

className: string = "BulkCreationParametersFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

instanceCount

instanceCount: object

serializedName

serializedName: string = "instanceCount"

type

type: object

name

name: "Number" = "Number"

Const ComputeDataDisk

ComputeDataDisk: object

A data disks attached to a virtual machine.

Optional diskSizeGiB

diskSizeGiB: undefined | number

Gets data disk size in GiB.

Optional diskUri

diskUri: undefined | string

When backed by a blob, the URI of underlying blob.

Optional managedDiskId

managedDiskId: undefined | string

When backed by managed disk, this is the ID of the compute disk resource.

Optional name

name: undefined | string

Gets data disk name.

serializedName

serializedName: string = "ComputeDataDisk"

type

type: object

className

className: string = "ComputeDataDisk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskSizeGiB

diskSizeGiB: object

serializedName

serializedName: string = "diskSizeGiB"

type

type: object

name

name: "Number" = "Number"

diskUri

diskUri: object

serializedName

serializedName: string = "diskUri"

type

type: object

name

name: "String" = "String"

managedDiskId

managedDiskId: object

serializedName

serializedName: string = "managedDiskId"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ComputeDataDiskFragment

ComputeDataDiskFragment: object

A data disks attached to a virtual machine.

Optional diskSizeGiB

diskSizeGiB: undefined | number

Gets data disk size in GiB.

Optional diskUri

diskUri: undefined | string

When backed by a blob, the URI of underlying blob.

Optional managedDiskId

managedDiskId: undefined | string

When backed by managed disk, this is the ID of the compute disk resource.

Optional name

name: undefined | string

Gets data disk name.

serializedName

serializedName: string = "ComputeDataDiskFragment"

type

type: object

className

className: string = "ComputeDataDiskFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskSizeGiB

diskSizeGiB: object

serializedName

serializedName: string = "diskSizeGiB"

type

type: object

name

name: "Number" = "Number"

diskUri

diskUri: object

serializedName

serializedName: string = "diskUri"

type

type: object

name

name: "String" = "String"

managedDiskId

managedDiskId: object

serializedName

serializedName: string = "managedDiskId"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ComputeVmInstanceViewStatus

ComputeVmInstanceViewStatus: object

Status information about a virtual machine.

Optional code

code: undefined | string

Gets the status Code.

Optional displayStatus

displayStatus: undefined | string

Gets the short localizable label for the status.

Optional message

message: undefined | string

Gets the message associated with the status.

serializedName

serializedName: string = "ComputeVmInstanceViewStatus"

type

type: object

className

className: string = "ComputeVmInstanceViewStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

displayStatus

displayStatus: object

serializedName

serializedName: string = "displayStatus"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const ComputeVmInstanceViewStatusFragment

ComputeVmInstanceViewStatusFragment: object

Status information about a virtual machine.

Optional code

code: undefined | string

Gets the status Code.

Optional displayStatus

displayStatus: undefined | string

Gets the short localizable label for the status.

Optional message

message: undefined | string

Gets the message associated with the status.

serializedName

serializedName: string = "ComputeVmInstanceViewStatusFragment"

type

type: object

className

className: string = "ComputeVmInstanceViewStatusFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

displayStatus

displayStatus: object

serializedName

serializedName: string = "displayStatus"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const ComputeVmProperties

ComputeVmProperties: object

Properties of a virtual machine returned by the Microsoft.Compute API.

Optional dataDiskIds

dataDiskIds: string[]

Gets data disks blob uri for the virtual machine.

Optional dataDisks

dataDisks: ComputeDataDisk[]

Gets all data disks attached to the virtual machine.

Optional networkInterfaceId

networkInterfaceId: undefined | string

Gets the network interface ID of the virtual machine.

Optional osDiskId

osDiskId: undefined | string

Gets OS disk blob uri for the virtual machine.

Optional osType

osType: undefined | string

Gets the OS type of the virtual machine.

Optional statuses

Gets the statuses of the virtual machine.

Optional vmSize

vmSize: undefined | string

Gets the size of the virtual machine.

serializedName

serializedName: string = "ComputeVmProperties"

type

type: object

className

className: string = "ComputeVmProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dataDiskIds

dataDiskIds: object

serializedName

serializedName: string = "dataDiskIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

dataDisks

dataDisks: object

serializedName

serializedName: string = "dataDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ComputeDataDisk"

name

name: "Composite" = "Composite"

networkInterfaceId

networkInterfaceId: object

serializedName

serializedName: string = "networkInterfaceId"

type

type: object

name

name: "String" = "String"

osDiskId

osDiskId: object

serializedName

serializedName: string = "osDiskId"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

statuses

statuses: object

serializedName

serializedName: string = "statuses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ComputeVmInstanceViewStatus"

name

name: "Composite" = "Composite"

vmSize

vmSize: object

serializedName

serializedName: string = "vmSize"

type

type: object

name

name: "String" = "String"

Const ComputeVmPropertiesFragment

ComputeVmPropertiesFragment: object

Properties of a virtual machine returned by the Microsoft.Compute API.

Optional dataDiskIds

dataDiskIds: string[]

Gets data disks blob uri for the virtual machine.

Optional dataDisks

Gets all data disks attached to the virtual machine.

Optional networkInterfaceId

networkInterfaceId: undefined | string

Gets the network interface ID of the virtual machine.

Optional osDiskId

osDiskId: undefined | string

Gets OS disk blob uri for the virtual machine.

Optional osType

osType: undefined | string

Gets the OS type of the virtual machine.

Optional statuses

Gets the statuses of the virtual machine.

Optional vmSize

vmSize: undefined | string

Gets the size of the virtual machine.

serializedName

serializedName: string = "ComputeVmPropertiesFragment"

type

type: object

className

className: string = "ComputeVmPropertiesFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dataDiskIds

dataDiskIds: object

serializedName

serializedName: string = "dataDiskIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

dataDisks

dataDisks: object

serializedName

serializedName: string = "dataDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ComputeDataDiskFragment"

name

name: "Composite" = "Composite"

networkInterfaceId

networkInterfaceId: object

serializedName

serializedName: string = "networkInterfaceId"

type

type: object

name

name: "String" = "String"

osDiskId

osDiskId: object

serializedName

serializedName: string = "osDiskId"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

statuses

statuses: object

serializedName

serializedName: string = "statuses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ComputeVmInstanceViewStatusFragment"

name

name: "Composite" = "Composite"

vmSize

vmSize: object

serializedName

serializedName: string = "vmSize"

type

type: object

name

name: "String" = "String"

Const CostThresholdProperties

CostThresholdProperties: object

Properties of a cost threshold item.

Optional displayOnChart

displayOnChart: CostThresholdStatus

Indicates whether this threshold will be displayed on cost charts. Possible values include: 'Enabled', 'Disabled'

Optional notificationSent

notificationSent: undefined | string

Indicates the datetime when notifications were last sent for this threshold.

Optional percentageThreshold

The value of the percentage cost threshold.

Optional sendNotificationWhenExceeded

sendNotificationWhenExceeded: CostThresholdStatus

Indicates whether notifications will be sent when this threshold is exceeded. Possible values include: 'Enabled', 'Disabled'

Optional thresholdId

thresholdId: undefined | string

The ID of the cost threshold item.

serializedName

serializedName: string = "CostThresholdProperties"

type

type: object

className

className: string = "CostThresholdProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayOnChart

displayOnChart: object

serializedName

serializedName: string = "displayOnChart"

type

type: object

name

name: "String" = "String"

notificationSent

notificationSent: object

serializedName

serializedName: string = "notificationSent"

type

type: object

name

name: "String" = "String"

percentageThreshold

percentageThreshold: object

serializedName

serializedName: string = "percentageThreshold"

type

type: object

className

className: string = "PercentageCostThresholdProperties"

name

name: "Composite" = "Composite"

sendNotificationWhenExceeded

sendNotificationWhenExceeded: object

serializedName

serializedName: string = "sendNotificationWhenExceeded"

type

type: object

name

name: "String" = "String"

thresholdId

thresholdId: object

serializedName

serializedName: string = "thresholdId"

type

type: object

name

name: "String" = "String"

Const CustomImage

CustomImage: object

A custom image.

Optional author

author: undefined | string

The author of the custom image.

Optional creationDate

creationDate: Date

The creation date of the custom image. NOTE: This property will not be serialized. It can only be populated by the server.

Optional customImagePlan

Storage information about the plan related to this custom image

Optional dataDiskStorageInfo

dataDiskStorageInfo: DataDiskStorageTypeInfo[]

Storage information about the data disks present in the custom image

Optional description

description: undefined | string

The description of the custom image.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isPlanAuthorized

isPlanAuthorized: undefined | false | true

Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment

Optional location

location: undefined | string

The location of the resource.

Optional managedImageId

managedImageId: undefined | string

The Managed Image Id backing the custom image.

Optional managedSnapshotId

managedSnapshotId: undefined | string

The Managed Snapshot Id backing the custom image.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

Optional vhd

The VHD from which the image is to be created.

Optional vm

The virtual machine from which the image is to be created.

serializedName

serializedName: string = "CustomImage"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "CustomImage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

author

author: object

serializedName

serializedName: string = "properties.author"

type

type: object

name

name: "String" = "String"

creationDate

creationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

customImagePlan

customImagePlan: object

serializedName

serializedName: string = "properties.customImagePlan"

type

type: object

className

className: string = "CustomImagePropertiesFromPlan"

name

name: "Composite" = "Composite"

dataDiskStorageInfo

dataDiskStorageInfo: object

serializedName

serializedName: string = "properties.dataDiskStorageInfo"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataDiskStorageTypeInfo"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isPlanAuthorized

isPlanAuthorized: object

serializedName

serializedName: string = "properties.isPlanAuthorized"

type

type: object

name

name: "Boolean" = "Boolean"

managedImageId

managedImageId: object

serializedName

serializedName: string = "properties.managedImageId"

type

type: object

name

name: "String" = "String"

managedSnapshotId

managedSnapshotId: object

serializedName

serializedName: string = "properties.managedSnapshotId"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

vhd

vhd: object

serializedName

serializedName: string = "properties.vhd"

type

type: object

className

className: string = "CustomImagePropertiesCustom"

name

name: "Composite" = "Composite"

vm

vm: object

serializedName

serializedName: string = "properties.vm"

type

type: object

className

className: string = "CustomImagePropertiesFromVm"

name

name: "Composite" = "Composite"

Const CustomImageFragment

CustomImageFragment: object

A custom image.

Optional author

author: undefined | string

The author of the custom image.

Optional customImagePlan

Storage information about the plan related to this custom image

Optional dataDiskStorageInfo

dataDiskStorageInfo: DataDiskStorageTypeInfoFragment[]

Storage information about the data disks present in the custom image

Optional description

description: undefined | string

The description of the custom image.

Optional isPlanAuthorized

isPlanAuthorized: undefined | false | true

Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment

Optional managedImageId

managedImageId: undefined | string

The Managed Image Id backing the custom image.

Optional managedSnapshotId

managedSnapshotId: undefined | string

The Managed Snapshot Id backing the custom image.

Optional tags

tags: undefined | object

The tags of the resource.

Optional vhd

The VHD from which the image is to be created.

Optional vm

The virtual machine from which the image is to be created.

serializedName

serializedName: string = "CustomImageFragment"

type

type: object

className

className: string = "CustomImageFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

author

author: object

serializedName

serializedName: string = "properties.author"

type

type: object

name

name: "String" = "String"

customImagePlan

customImagePlan: object

serializedName

serializedName: string = "properties.customImagePlan"

type

type: object

className

className: string = "CustomImagePropertiesFromPlanFragment"

name

name: "Composite" = "Composite"

dataDiskStorageInfo

dataDiskStorageInfo: object

serializedName

serializedName: string = "properties.dataDiskStorageInfo"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataDiskStorageTypeInfoFragment"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isPlanAuthorized

isPlanAuthorized: object

serializedName

serializedName: string = "properties.isPlanAuthorized"

type

type: object

name

name: "Boolean" = "Boolean"

managedImageId

managedImageId: object

serializedName

serializedName: string = "properties.managedImageId"

type

type: object

name

name: "String" = "String"

managedSnapshotId

managedSnapshotId: object

serializedName

serializedName: string = "properties.managedSnapshotId"

type

type: object

name

name: "String" = "String"

vhd

vhd: object

serializedName

serializedName: string = "properties.vhd"

type

type: object

className

className: string = "CustomImagePropertiesCustomFragment"

name

name: "Composite" = "Composite"

vm

vm: object

serializedName

serializedName: string = "properties.vm"

type

type: object

className

className: string = "CustomImagePropertiesFromVmFragment"

name

name: "Composite" = "Composite"

Const CustomImageList

CustomImageList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "CustomImageList"

__@iterator

  • Iterator

    Returns IterableIterator<CustomImage>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<CustomImage>[]

      Additional items to add to the end of array1.

    Returns CustomImage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns CustomImage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CustomImage]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: CustomImage, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CustomImage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): CustomImage[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CustomImage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): CustomImage | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns CustomImage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: CustomImage, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: CustomImage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: CustomImage, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CustomImage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: CustomImage, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CustomImage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns CustomImage | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: CustomImage[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns CustomImage

  • Parameters

    Returns CustomImage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): CustomImage
  • reduceRight(callbackfn: function, initialValue: CustomImage): CustomImage
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns CustomImage

  • Parameters

    Returns CustomImage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns CustomImage[]

shift

  • Removes the first element from an array and returns it.

    Returns CustomImage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): CustomImage[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns CustomImage[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns CustomImage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CustomImage[]

      Elements to insert into the array in place of the deleted elements.

    Returns CustomImage[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: CustomImage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<CustomImage>

type

type: object

className

className: string = "CustomImageList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CustomImage"

name

name: "Composite" = "Composite"

Const CustomImagePropertiesCustom

CustomImagePropertiesCustom: object

Properties for creating a custom image from a VHD.

Optional imageName

imageName: undefined | string

The image name.

osType

The OS type of the custom image (i.e. Windows, Linux). Possible values include: 'Windows', 'Linux', 'None'

Optional sysPrep

sysPrep: undefined | false | true

Indicates whether sysprep has been run on the VHD.

serializedName

serializedName: string = "CustomImagePropertiesCustom"

type

type: object

className

className: string = "CustomImagePropertiesCustom"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

imageName

imageName: object

serializedName

serializedName: string = "imageName"

type

type: object

name

name: "String" = "String"

osType

osType: object

required

required: true = true

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

sysPrep

sysPrep: object

serializedName

serializedName: string = "sysPrep"

type

type: object

name

name: "Boolean" = "Boolean"

Const CustomImagePropertiesCustomFragment

CustomImagePropertiesCustomFragment: object

Properties for creating a custom image from a VHD.

Optional imageName

imageName: undefined | string

The image name.

Optional osType

The OS type of the custom image (i.e. Windows, Linux). Possible values include: 'Windows', 'Linux', 'None'

Optional sysPrep

sysPrep: undefined | false | true

Indicates whether sysprep has been run on the VHD.

serializedName

serializedName: string = "CustomImagePropertiesCustomFragment"

type

type: object

className

className: string = "CustomImagePropertiesCustomFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

imageName

imageName: object

serializedName

serializedName: string = "imageName"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

sysPrep

sysPrep: object

serializedName

serializedName: string = "sysPrep"

type

type: object

name

name: "Boolean" = "Boolean"

Const CustomImagePropertiesFromPlan

CustomImagePropertiesFromPlan: object

Properties for plan on a custom image.

Optional id

id: undefined | string

The id of the plan, equivalent to name of the plan

Optional offer

offer: undefined | string

The offer for the plan from the marketplace image the custom image is derived from

Optional publisher

publisher: undefined | string

The publisher for the plan from the marketplace image the custom image is derived from

serializedName

serializedName: string = "CustomImagePropertiesFromPlan"

type

type: object

className

className: string = "CustomImagePropertiesFromPlan"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

offer

offer: object

serializedName

serializedName: string = "offer"

type

type: object

name

name: "String" = "String"

publisher

publisher: object

serializedName

serializedName: string = "publisher"

type

type: object

name

name: "String" = "String"

Const CustomImagePropertiesFromPlanFragment

CustomImagePropertiesFromPlanFragment: object

Properties for plan on a custom image.

Optional id

id: undefined | string

The id of the plan, equivalent to name of the plan

Optional offer

offer: undefined | string

The offer for the plan from the marketplace image the custom image is derived from

Optional publisher

publisher: undefined | string

The publisher for the plan from the marketplace image the custom image is derived from

serializedName

serializedName: string = "CustomImagePropertiesFromPlanFragment"

type

type: object

className

className: string = "CustomImagePropertiesFromPlanFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

offer

offer: object

serializedName

serializedName: string = "offer"

type

type: object

name

name: "String" = "String"

publisher

publisher: object

serializedName

serializedName: string = "publisher"

type

type: object

name

name: "String" = "String"

Const CustomImagePropertiesFromVm

CustomImagePropertiesFromVm: object

Properties for creating a custom image from a virtual machine.

Optional linuxOsInfo

linuxOsInfo: LinuxOsInfo

The Linux OS information of the VM.

Optional sourceVmId

sourceVmId: undefined | string

The source vm identifier.

Optional windowsOsInfo

windowsOsInfo: WindowsOsInfo

The Windows OS information of the VM.

serializedName

serializedName: string = "CustomImagePropertiesFromVm"

type

type: object

className

className: string = "CustomImagePropertiesFromVm"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

linuxOsInfo

linuxOsInfo: object

serializedName

serializedName: string = "linuxOsInfo"

type

type: object

className

className: string = "LinuxOsInfo"

name

name: "Composite" = "Composite"

sourceVmId

sourceVmId: object

serializedName

serializedName: string = "sourceVmId"

type

type: object

name

name: "String" = "String"

windowsOsInfo

windowsOsInfo: object

serializedName

serializedName: string = "windowsOsInfo"

type

type: object

className

className: string = "WindowsOsInfo"

name

name: "Composite" = "Composite"

Const CustomImagePropertiesFromVmFragment

CustomImagePropertiesFromVmFragment: object

Properties for creating a custom image from a virtual machine.

Optional linuxOsInfo

linuxOsInfo: LinuxOsInfoFragment

The Linux OS information of the VM.

Optional sourceVmId

sourceVmId: undefined | string

The source vm identifier.

Optional windowsOsInfo

windowsOsInfo: WindowsOsInfoFragment

The Windows OS information of the VM.

serializedName

serializedName: string = "CustomImagePropertiesFromVmFragment"

type

type: object

className

className: string = "CustomImagePropertiesFromVmFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

linuxOsInfo

linuxOsInfo: object

serializedName

serializedName: string = "linuxOsInfo"

type

type: object

className

className: string = "LinuxOsInfoFragment"

name

name: "Composite" = "Composite"

sourceVmId

sourceVmId: object

serializedName

serializedName: string = "sourceVmId"

type

type: object

name

name: "String" = "String"

windowsOsInfo

windowsOsInfo: object

serializedName

serializedName: string = "windowsOsInfo"

type

type: object

className

className: string = "WindowsOsInfoFragment"

name

name: "Composite" = "Composite"

Const DataDiskProperties

DataDiskProperties: object

Request body for adding a new or existing data disk to a virtual machine.

Optional attachNewDataDiskOptions

attachNewDataDiskOptions: AttachNewDataDiskOptions

Specifies options to attach a new disk to the virtual machine.

Optional existingLabDiskId

existingLabDiskId: undefined | string

Specifies the existing lab disk id to attach to virtual machine.

Optional hostCaching

hostCaching: HostCachingOptions

Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). Possible values include: 'None', 'ReadOnly', 'ReadWrite'

serializedName

serializedName: string = "DataDiskProperties"

type

type: object

className

className: string = "DataDiskProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

attachNewDataDiskOptions

attachNewDataDiskOptions: object

serializedName

serializedName: string = "attachNewDataDiskOptions"

type

type: object

className

className: string = "AttachNewDataDiskOptions"

name

name: "Composite" = "Composite"

existingLabDiskId

existingLabDiskId: object

serializedName

serializedName: string = "existingLabDiskId"

type

type: object

name

name: "String" = "String"

hostCaching

hostCaching: object

serializedName

serializedName: string = "hostCaching"

type

type: object

name

name: "String" = "String"

Const DataDiskPropertiesFragment

DataDiskPropertiesFragment: object

Request body for adding a new or existing data disk to a virtual machine.

Optional attachNewDataDiskOptions

attachNewDataDiskOptions: AttachNewDataDiskOptionsFragment

Specifies options to attach a new disk to the virtual machine.

Optional existingLabDiskId

existingLabDiskId: undefined | string

Specifies the existing lab disk id to attach to virtual machine.

Optional hostCaching

hostCaching: HostCachingOptions

Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). Possible values include: 'None', 'ReadOnly', 'ReadWrite'

serializedName

serializedName: string = "DataDiskPropertiesFragment"

type

type: object

className

className: string = "DataDiskPropertiesFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

attachNewDataDiskOptions

attachNewDataDiskOptions: object

serializedName

serializedName: string = "attachNewDataDiskOptions"

type

type: object

className

className: string = "AttachNewDataDiskOptionsFragment"

name

name: "Composite" = "Composite"

existingLabDiskId

existingLabDiskId: object

serializedName

serializedName: string = "existingLabDiskId"

type

type: object

name

name: "String" = "String"

hostCaching

hostCaching: object

serializedName

serializedName: string = "hostCaching"

type

type: object

name

name: "String" = "String"

Const DataDiskStorageTypeInfo

DataDiskStorageTypeInfo: object

Storage information about the data disks present in the custom image

Optional lun

lun: undefined | string

Disk Lun

Optional storageType

storageType: StorageType

Disk Storage Type. Possible values include: 'Standard', 'Premium'

serializedName

serializedName: string = "DataDiskStorageTypeInfo"

type

type: object

className

className: string = "DataDiskStorageTypeInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lun

lun: object

serializedName

serializedName: string = "lun"

type

type: object

name

name: "String" = "String"

storageType

storageType: object

serializedName

serializedName: string = "storageType"

type

type: object

name

name: "String" = "String"

Const DataDiskStorageTypeInfoFragment

DataDiskStorageTypeInfoFragment: object

Storage information about the data disks present in the custom image

Optional lun

lun: undefined | string

Disk Lun

Optional storageType

storageType: StorageType

Disk Storage Type. Possible values include: 'Standard', 'Premium'

serializedName

serializedName: string = "DataDiskStorageTypeInfoFragment"

type

type: object

className

className: string = "DataDiskStorageTypeInfoFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lun

lun: object

serializedName

serializedName: string = "lun"

type

type: object

name

name: "String" = "String"

storageType

storageType: object

serializedName

serializedName: string = "storageType"

type

type: object

name

name: "String" = "String"

Const DayDetails

DayDetails: object

Properties of a daily schedule.

Optional time

time: undefined | string

The time of day the schedule will occur.

serializedName

serializedName: string = "DayDetails"

type

type: object

className

className: string = "DayDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

time

time: object

serializedName

serializedName: string = "time"

type

type: object

name

name: "String" = "String"

Const DayDetailsFragment

DayDetailsFragment: object

Properties of a daily schedule.

Optional time

time: undefined | string

The time of day the schedule will occur.

serializedName

serializedName: string = "DayDetailsFragment"

type

type: object

className

className: string = "DayDetailsFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

time

time: object

serializedName

serializedName: string = "time"

type

type: object

name

name: "String" = "String"

Const DetachDataDiskProperties

DetachDataDiskProperties: object

Request body for detaching data disk from a virtual machine.

Optional existingLabDiskId

existingLabDiskId: undefined | string

Specifies the disk resource ID to detach from virtual machine.

serializedName

serializedName: string = "DetachDataDiskProperties"

type

type: object

className

className: string = "DetachDataDiskProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

existingLabDiskId

existingLabDiskId: object

serializedName

serializedName: string = "existingLabDiskId"

type

type: object

name

name: "String" = "String"

Const DetachDiskProperties

DetachDiskProperties: object

Properties of the disk to detach.

Optional leasedByLabVmId

leasedByLabVmId: undefined | string

The resource ID of the Lab VM to which the disk is attached.

serializedName

serializedName: string = "DetachDiskProperties"

type

type: object

className

className: string = "DetachDiskProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

leasedByLabVmId

leasedByLabVmId: object

serializedName

serializedName: string = "leasedByLabVmId"

type

type: object

name

name: "String" = "String"

Const Disk

Disk: object

A Disk.

Optional createdDate

createdDate: Date

The creation date of the disk. NOTE: This property will not be serialized. It can only be populated by the server.

Optional diskBlobName

diskBlobName: undefined | string

When backed by a blob, the name of the VHD blob without extension.

Optional diskSizeGiB

diskSizeGiB: undefined | number

The size of the disk in Gibibytes.

Optional diskType

diskType: StorageType

The storage type for the disk (i.e. Standard, Premium). Possible values include: 'Standard', 'Premium'

Optional diskUri

diskUri: undefined | string

When backed by a blob, the URI of underlying blob.

Optional hostCaching

hostCaching: undefined | string

The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional leasedByLabVmId

leasedByLabVmId: undefined | string

The resource ID of the VM to which this disk is leased.

Optional location

location: undefined | string

The location of the resource.

Optional managedDiskId

managedDiskId: undefined | string

When backed by managed disk, this is the ID of the compute disk resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Disk"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Disk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

diskBlobName

diskBlobName: object

serializedName

serializedName: string = "properties.diskBlobName"

type

type: object

name

name: "String" = "String"

diskSizeGiB

diskSizeGiB: object

serializedName

serializedName: string = "properties.diskSizeGiB"

type

type: object

name

name: "Number" = "Number"

diskType

diskType: object

serializedName

serializedName: string = "properties.diskType"

type

type: object

name

name: "String" = "String"

diskUri

diskUri: object

serializedName

serializedName: string = "properties.diskUri"

type

type: object

name

name: "String" = "String"

hostCaching

hostCaching: object

serializedName

serializedName: string = "properties.hostCaching"

type

type: object

name

name: "String" = "String"

leasedByLabVmId

leasedByLabVmId: object

serializedName

serializedName: string = "properties.leasedByLabVmId"

type

type: object

name

name: "String" = "String"

managedDiskId

managedDiskId: object

serializedName

serializedName: string = "properties.managedDiskId"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

Const DiskFragment

DiskFragment: object

A Disk.

Optional diskBlobName

diskBlobName: undefined | string

When backed by a blob, the name of the VHD blob without extension.

Optional diskSizeGiB

diskSizeGiB: undefined | number

The size of the disk in Gibibytes.

Optional diskType

diskType: StorageType

The storage type for the disk (i.e. Standard, Premium). Possible values include: 'Standard', 'Premium'

Optional diskUri

diskUri: undefined | string

When backed by a blob, the URI of underlying blob.

Optional hostCaching

hostCaching: undefined | string

The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).

Optional leasedByLabVmId

leasedByLabVmId: undefined | string

The resource ID of the VM to which this disk is leased.

Optional managedDiskId

managedDiskId: undefined | string

When backed by managed disk, this is the ID of the compute disk resource.

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "DiskFragment"

type

type: object

className

className: string = "DiskFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskBlobName

diskBlobName: object

serializedName

serializedName: string = "properties.diskBlobName"

type

type: object

name

name: "String" = "String"

diskSizeGiB

diskSizeGiB: object

serializedName

serializedName: string = "properties.diskSizeGiB"

type

type: object

name

name: "Number" = "Number"

diskType

diskType: object

serializedName

serializedName: string = "properties.diskType"

type

type: object

name

name: "String" = "String"

diskUri

diskUri: object

serializedName

serializedName: string = "properties.diskUri"

type

type: object

name

name: "String" = "String"

hostCaching

hostCaching: object

serializedName

serializedName: string = "properties.hostCaching"

type

type: object

name

name: "String" = "String"

leasedByLabVmId

leasedByLabVmId: object

serializedName

serializedName: string = "properties.leasedByLabVmId"

type

type: object

name

name: "String" = "String"

managedDiskId

managedDiskId: object

serializedName

serializedName: string = "properties.managedDiskId"

type

type: object

name

name: "String" = "String"

Const DiskList

DiskList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "DiskList"

__@iterator

  • __@iterator(): IterableIterator<Disk>
  • Iterator

    Returns IterableIterator<Disk>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Disk>[]): Disk[]
  • concat(...items: (T | ConcatArray<T>)[]): Disk[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Disk>[]

      Additional items to add to the end of array1.

    Returns Disk[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Disk[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Disk]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Disk]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Disk, index: number, array: Disk[]): boolean
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Disk, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Disk

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Disk[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Disk, index: number, array: Disk[]): boolean
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Disk, index: number, array: Disk[]): any
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Disk[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Disk | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Disk, index: number, obj: Disk[]): boolean
        • Parameters

          • this: void
          • value: Disk
          • index: number
          • obj: Disk[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Disk, index: number, obj: Disk[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Disk | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Disk, index: number, obj: Disk[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Disk, index: number, array: Disk[]): void
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Disk, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Disk

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Disk, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Disk

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Disk, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Disk

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Disk, index: number, array: Disk[]): U
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Disk | undefined
  • Removes the last element from an array and returns it.

    Returns Disk | undefined

push

  • push(...items: Disk[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Disk[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Disk
  • reduce(callbackfn: function, initialValue: Disk): Disk
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Disk, currentValue: Disk, currentIndex: number, array: Disk[]): Disk
        • Parameters

          • previousValue: Disk
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns Disk

    Returns Disk

  • Parameters

    • callbackfn: function
        • (previousValue: Disk, currentValue: Disk, currentIndex: number, array: Disk[]): Disk
        • Parameters

          • previousValue: Disk
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns Disk

    • initialValue: Disk

    Returns Disk

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Disk, currentIndex: number, array: Disk[]): U
        • Parameters

          • previousValue: U
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Disk
  • reduceRight(callbackfn: function, initialValue: Disk): Disk
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Disk, currentValue: Disk, currentIndex: number, array: Disk[]): Disk
        • Parameters

          • previousValue: Disk
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns Disk

    Returns Disk

  • Parameters

    • callbackfn: function
        • (previousValue: Disk, currentValue: Disk, currentIndex: number, array: Disk[]): Disk
        • Parameters

          • previousValue: Disk
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns Disk

    • initialValue: Disk

    Returns Disk

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Disk, currentIndex: number, array: Disk[]): U
        • Parameters

          • previousValue: U
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Disk[]

shift

  • shift(): Disk | undefined
  • Removes the first element from an array and returns it.

    Returns Disk | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Disk[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Disk[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Disk, index: number, array: Disk[]): boolean
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Disk[]
  • splice(start: number, deleteCount: number, ...items: Disk[]): Disk[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Disk[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Disk[]

      Elements to insert into the array in place of the deleted elements.

    Returns Disk[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Disk[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Disk[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Disk>
  • Returns an iterable of values in the array

    Returns IterableIterator<Disk>

type

type: object

className

className: string = "DiskList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Disk"

name

name: "Composite" = "Composite"

Const DtlEnvironment

DtlEnvironment: object

An environment, which is essentially an ARM template deployment.

Optional armTemplateDisplayName

armTemplateDisplayName: undefined | string

The display name of the Azure Resource Manager template that produced the environment.

Optional createdByUser

createdByUser: undefined | string

The creator of the environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional deploymentProperties

deploymentProperties: EnvironmentDeploymentProperties

The deployment properties of the environment.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGroupId

resourceGroupId: undefined | string

The identifier of the resource group containing the environment's resources. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DtlEnvironment"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "DtlEnvironment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

armTemplateDisplayName

armTemplateDisplayName: object

serializedName

serializedName: string = "properties.armTemplateDisplayName"

type

type: object

name

name: "String" = "String"

createdByUser

createdByUser: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdByUser"

type

type: object

name

name: "String" = "String"

deploymentProperties

deploymentProperties: object

serializedName

serializedName: string = "properties.deploymentProperties"

type

type: object

className

className: string = "EnvironmentDeploymentProperties"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGroupId

resourceGroupId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGroupId"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

Const DtlEnvironmentFragment

DtlEnvironmentFragment: object

An environment, which is essentially an ARM template deployment.

Optional armTemplateDisplayName

armTemplateDisplayName: undefined | string

The display name of the Azure Resource Manager template that produced the environment.

Optional deploymentProperties

The deployment properties of the environment.

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "DtlEnvironmentFragment"

type

type: object

className

className: string = "DtlEnvironmentFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

armTemplateDisplayName

armTemplateDisplayName: object

serializedName

serializedName: string = "properties.armTemplateDisplayName"

type

type: object

name

name: "String" = "String"

deploymentProperties

deploymentProperties: object

serializedName

serializedName: string = "properties.deploymentProperties"

type

type: object

className

className: string = "EnvironmentDeploymentPropertiesFragment"

name

name: "Composite" = "Composite"

Const DtlEnvironmentList

DtlEnvironmentList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "DtlEnvironmentList"

__@iterator

  • Iterator

    Returns IterableIterator<DtlEnvironment>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DtlEnvironment>[]

      Additional items to add to the end of array1.

    Returns DtlEnvironment[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DtlEnvironment[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DtlEnvironment]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DtlEnvironment, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DtlEnvironment

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DtlEnvironment[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DtlEnvironment[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DtlEnvironment | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns DtlEnvironment | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DtlEnvironment, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DtlEnvironment

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: DtlEnvironment, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DtlEnvironment

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DtlEnvironment, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DtlEnvironment

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns DtlEnvironment | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DtlEnvironment

  • Parameters

    Returns DtlEnvironment

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DtlEnvironment

  • Parameters

    Returns DtlEnvironment

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns DtlEnvironment[]

shift

  • Removes the first element from an array and returns it.

    Returns DtlEnvironment | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): DtlEnvironment[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DtlEnvironment[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DtlEnvironment[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DtlEnvironment[]

      Elements to insert into the array in place of the deleted elements.

    Returns DtlEnvironment[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: DtlEnvironment[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<DtlEnvironment>

type

type: object

className

className: string = "DtlEnvironmentList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DtlEnvironment"

name

name: "Composite" = "Composite"

Const EnvironmentDeploymentProperties

EnvironmentDeploymentProperties: object

Properties of an environment deployment.

Optional armTemplateId

armTemplateId: undefined | string

The Azure Resource Manager template's identifier.

Optional parameters

The parameters of the Azure Resource Manager template.

serializedName

serializedName: string = "EnvironmentDeploymentProperties"

type

type: object

className

className: string = "EnvironmentDeploymentProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

armTemplateId

armTemplateId: object

serializedName

serializedName: string = "armTemplateId"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArmTemplateParameterProperties"

name

name: "Composite" = "Composite"

Const EnvironmentDeploymentPropertiesFragment

EnvironmentDeploymentPropertiesFragment: object

Properties of an environment deployment.

Optional armTemplateId

armTemplateId: undefined | string

The Azure Resource Manager template's identifier.

Optional parameters

The parameters of the Azure Resource Manager template.

serializedName

serializedName: string = "EnvironmentDeploymentPropertiesFragment"

type

type: object

className

className: string = "EnvironmentDeploymentPropertiesFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

armTemplateId

armTemplateId: object

serializedName

serializedName: string = "armTemplateId"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArmTemplateParameterPropertiesFragment"

name

name: "Composite" = "Composite"

Const EvaluatePoliciesProperties

EvaluatePoliciesProperties: object

Properties for evaluating a policy set.

Optional factData

factData: undefined | string

The fact data.

Optional factName

factName: undefined | string

The fact name.

Optional userObjectId

userObjectId: undefined | string

The user for which policies will be evaluated

Optional valueOffset

valueOffset: undefined | string

The value offset.

serializedName

serializedName: string = "EvaluatePoliciesProperties"

type

type: object

className

className: string = "EvaluatePoliciesProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

factData

factData: object

serializedName

serializedName: string = "factData"

type

type: object

name

name: "String" = "String"

factName

factName: object

serializedName

serializedName: string = "factName"

type

type: object

name

name: "String" = "String"

userObjectId

userObjectId: object

serializedName

serializedName: string = "userObjectId"

type

type: object

name

name: "String" = "String"

valueOffset

valueOffset: object

serializedName

serializedName: string = "valueOffset"

type

type: object

name

name: "String" = "String"

Const EvaluatePoliciesRequest

EvaluatePoliciesRequest: object

Request body for evaluating a policy set.

Optional policies

Policies to evaluate.

serializedName

serializedName: string = "EvaluatePoliciesRequest"

type

type: object

className

className: string = "EvaluatePoliciesRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

policies

policies: object

serializedName

serializedName: string = "policies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EvaluatePoliciesProperties"

name

name: "Composite" = "Composite"

Const EvaluatePoliciesResponse

EvaluatePoliciesResponse: object

Response body for evaluating a policy set.

Optional results

results: PolicySetResult[]

Results of evaluating a policy set.

serializedName

serializedName: string = "EvaluatePoliciesResponse"

type

type: object

className

className: string = "EvaluatePoliciesResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

results

results: object

serializedName

serializedName: string = "results"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PolicySetResult"

name

name: "Composite" = "Composite"

Const Event

Event: object

An event to be notified for.

Optional eventName

The event type for which this notification is enabled (i.e. AutoShutdown, Cost). Possible values include: 'AutoShutdown', 'Cost'

serializedName

serializedName: string = "Event"

type

type: object

className

className: string = "Event"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eventName

eventName: object

serializedName

serializedName: string = "eventName"

type

type: object

name

name: "String" = "String"

Const EventFragment

EventFragment: object

An event to be notified for.

Optional eventName

The event type for which this notification is enabled (i.e. AutoShutdown, Cost). Possible values include: 'AutoShutdown', 'Cost'

serializedName

serializedName: string = "EventFragment"

type

type: object

className

className: string = "EventFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eventName

eventName: object

serializedName

serializedName: string = "eventName"

type

type: object

name

name: "String" = "String"

Const ExportResourceUsageParameters

ExportResourceUsageParameters: object

The parameters of the export operation.

Optional blobStorageAbsoluteSasUri

blobStorageAbsoluteSasUri: undefined | string

The blob storage absolute sas uri with write permission to the container which the usage data needs to be uploaded to.

Optional usageStartDate

usageStartDate: Date

The start time of the usage. If not provided, usage will be reported since the beginning of data collection.

serializedName

serializedName: string = "ExportResourceUsageParameters"

type

type: object

className

className: string = "ExportResourceUsageParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobStorageAbsoluteSasUri

blobStorageAbsoluteSasUri: object

serializedName

serializedName: string = "blobStorageAbsoluteSasUri"

type

type: object

name

name: "String" = "String"

usageStartDate

usageStartDate: object

serializedName

serializedName: string = "usageStartDate"

type

type: object

name

name: "DateTime" = "DateTime"

Const ExternalSubnet

ExternalSubnet: object

Subnet information as returned by the Microsoft.Network API.

Optional id

id: undefined | string

Gets or sets the identifier.

Optional name

name: undefined | string

Gets or sets the name.

serializedName

serializedName: string = "ExternalSubnet"

type

type: object

className

className: string = "ExternalSubnet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ExternalSubnetFragment

ExternalSubnetFragment: object

Subnet information as returned by the Microsoft.Network API.

Optional id

id: undefined | string

Gets or sets the identifier.

Optional name

name: undefined | string

Gets or sets the name.

serializedName

serializedName: string = "ExternalSubnetFragment"

type

type: object

className

className: string = "ExternalSubnetFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const Formula

Formula: object

A formula for creating a VM, specifying an image base and other parameters

Optional author

author: undefined | string

The author of the formula.

Optional creationDate

creationDate: Date

The creation date of the formula. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

The description of the formula.

Optional formulaContent

The content of the formula.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional osType

osType: undefined | string

The OS type of the formula.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

Optional vm

Information about a VM from which a formula is to be created.

serializedName

serializedName: string = "Formula"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Formula"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

author

author: object

serializedName

serializedName: string = "properties.author"

type

type: object

name

name: "String" = "String"

creationDate

creationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationDate"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

formulaContent

formulaContent: object

serializedName

serializedName: string = "properties.formulaContent"

type

type: object

className

className: string = "LabVirtualMachineCreationParameter"

name

name: "Composite" = "Composite"

osType

osType: object

serializedName

serializedName: string = "properties.osType"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

vm

vm: object

serializedName

serializedName: string = "properties.vm"

type

type: object

className

className: string = "FormulaPropertiesFromVm"

name

name: "Composite" = "Composite"

Const FormulaFragment

FormulaFragment: object

A formula for creating a VM, specifying an image base and other parameters

Optional author

author: undefined | string

The author of the formula.

Optional description

description: undefined | string

The description of the formula.

Optional formulaContent

The content of the formula.

Optional osType

osType: undefined | string

The OS type of the formula.

Optional tags

tags: undefined | object

The tags of the resource.

Optional vm

Information about a VM from which a formula is to be created.

serializedName

serializedName: string = "FormulaFragment"

type

type: object

className

className: string = "FormulaFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

author

author: object

serializedName

serializedName: string = "properties.author"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

formulaContent

formulaContent: object

serializedName

serializedName: string = "properties.formulaContent"

type

type: object

className

className: string = "LabVirtualMachineCreationParameterFragment"

name

name: "Composite" = "Composite"

osType

osType: object

serializedName

serializedName: string = "properties.osType"

type

type: object

name

name: "String" = "String"

vm

vm: object

serializedName

serializedName: string = "properties.vm"

type

type: object

className

className: string = "FormulaPropertiesFromVmFragment"

name

name: "Composite" = "Composite"

Const FormulaList

FormulaList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "FormulaList"

__@iterator

  • __@iterator(): IterableIterator<Formula>
  • Iterator

    Returns IterableIterator<Formula>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Formula>[]): Formula[]
  • concat(...items: (T | ConcatArray<T>)[]): Formula[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Formula>[]

      Additional items to add to the end of array1.

    Returns Formula[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Formula[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Formula]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Formula]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Formula, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Formula

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Formula[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Formula[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Formula | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Formula, index: number, obj: Formula[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Formula | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Formula, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Formula

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Formula, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Formula

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Formula, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Formula

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Formula | undefined

push

  • push(...items: Formula[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Formula[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Formula
  • reduce(callbackfn: function, initialValue: Formula): Formula
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Formula

  • Parameters

    Returns Formula

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Formula, currentIndex: number, array: Formula[]): U
        • Parameters

          • previousValue: U
          • currentValue: Formula
          • currentIndex: number
          • array: Formula[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Formula
  • reduceRight(callbackfn: function, initialValue: Formula): Formula
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Formula

  • Parameters

    Returns Formula

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Formula, currentIndex: number, array: Formula[]): U
        • Parameters

          • previousValue: U
          • currentValue: Formula
          • currentIndex: number
          • array: Formula[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Formula[]

shift

  • Removes the first element from an array and returns it.

    Returns Formula | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Formula[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Formula[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Formula[]
  • splice(start: number, deleteCount: number, ...items: Formula[]): Formula[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Formula[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Formula[]

      Elements to insert into the array in place of the deleted elements.

    Returns Formula[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Formula[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Formula[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Formula>
  • Returns an iterable of values in the array

    Returns IterableIterator<Formula>

type

type: object

className

className: string = "FormulaList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Formula"

name

name: "Composite" = "Composite"

Const FormulaPropertiesFromVm

FormulaPropertiesFromVm: object

Information about a VM from which a formula is to be created.

Optional labVmId

labVmId: undefined | string

The identifier of the VM from which a formula is to be created.

serializedName

serializedName: string = "FormulaPropertiesFromVm"

type

type: object

className

className: string = "FormulaPropertiesFromVm"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

labVmId

labVmId: object

serializedName

serializedName: string = "labVmId"

type

type: object

name

name: "String" = "String"

Const FormulaPropertiesFromVmFragment

FormulaPropertiesFromVmFragment: object

Information about a VM from which a formula is to be created.

Optional labVmId

labVmId: undefined | string

The identifier of the VM from which a formula is to be created.

serializedName

serializedName: string = "FormulaPropertiesFromVmFragment"

type

type: object

className

className: string = "FormulaPropertiesFromVmFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

labVmId

labVmId: object

serializedName

serializedName: string = "labVmId"

type

type: object

name

name: "String" = "String"

Const GalleryImage

GalleryImage: object

A gallery image.

Optional author

author: undefined | string

The author of the gallery image.

Optional createdDate

createdDate: Date

The creation date of the gallery image. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

The description of the gallery image.

Optional enabled

enabled: undefined | false | true

Indicates whether this gallery image is enabled.

Optional icon

icon: undefined | string

The icon of the gallery image.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional imageReference

imageReference: GalleryImageReference

The image reference of the gallery image.

Optional isPlanAuthorized

isPlanAuthorized: undefined | false | true

Indicates if the plan has been authorized for programmatic deployment.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional planId

planId: undefined | string

The third party plan that applies to this image

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "GalleryImage"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "GalleryImage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

author

author: object

serializedName

serializedName: string = "properties.author"

type

type: object

name

name: "String" = "String"

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

icon

icon: object

serializedName

serializedName: string = "properties.icon"

type

type: object

name

name: "String" = "String"

imageReference

imageReference: object

serializedName

serializedName: string = "properties.imageReference"

type

type: object

className

className: string = "GalleryImageReference"

name

name: "Composite" = "Composite"

isPlanAuthorized

isPlanAuthorized: object

serializedName

serializedName: string = "properties.isPlanAuthorized"

type

type: object

name

name: "Boolean" = "Boolean"

planId

planId: object

serializedName

serializedName: string = "properties.planId"

type

type: object

name

name: "String" = "String"

Const GalleryImageList

GalleryImageList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "GalleryImageList"

__@iterator

  • Iterator

    Returns IterableIterator<GalleryImage>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<GalleryImage>[]

      Additional items to add to the end of array1.

    Returns GalleryImage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns GalleryImage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, GalleryImage]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: GalleryImage, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: GalleryImage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): GalleryImage[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns GalleryImage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): GalleryImage | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns GalleryImage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: GalleryImage, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: GalleryImage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: GalleryImage, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: GalleryImage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: GalleryImage, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: GalleryImage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns GalleryImage | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns GalleryImage

  • Parameters

    Returns GalleryImage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): GalleryImage
  • reduceRight(callbackfn: function, initialValue: GalleryImage): GalleryImage
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns GalleryImage

  • Parameters

    Returns GalleryImage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns GalleryImage[]

shift

  • Removes the first element from an array and returns it.

    Returns GalleryImage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): GalleryImage[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns GalleryImage[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns GalleryImage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: GalleryImage[]

      Elements to insert into the array in place of the deleted elements.

    Returns GalleryImage[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: GalleryImage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<GalleryImage>

type

type: object

className

className: string = "GalleryImageList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GalleryImage"

name

name: "Composite" = "Composite"

Const GalleryImageReference

GalleryImageReference: object

The reference information for an Azure Marketplace image.

Optional offer

offer: undefined | string

The offer of the gallery image.

Optional osType

osType: undefined | string

The OS type of the gallery image.

Optional publisher

publisher: undefined | string

The publisher of the gallery image.

Optional sku

sku: undefined | string

The SKU of the gallery image.

Optional version

version: undefined | string

The version of the gallery image.

serializedName

serializedName: string = "GalleryImageReference"

type

type: object

className

className: string = "GalleryImageReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

offer

offer: object

serializedName

serializedName: string = "offer"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

publisher

publisher: object

serializedName

serializedName: string = "publisher"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const GalleryImageReferenceFragment

GalleryImageReferenceFragment: object

The reference information for an Azure Marketplace image.

Optional offer

offer: undefined | string

The offer of the gallery image.

Optional osType

osType: undefined | string

The OS type of the gallery image.

Optional publisher

publisher: undefined | string

The publisher of the gallery image.

Optional sku

sku: undefined | string

The SKU of the gallery image.

Optional version

version: undefined | string

The version of the gallery image.

serializedName

serializedName: string = "GalleryImageReferenceFragment"

type

type: object

className

className: string = "GalleryImageReferenceFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

offer

offer: object

serializedName

serializedName: string = "offer"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

publisher

publisher: object

serializedName

serializedName: string = "publisher"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const GenerateArmTemplateRequest

GenerateArmTemplateRequest: object

Parameters for generating an ARM template for deploying artifacts.

Optional fileUploadOptions

fileUploadOptions: FileUploadOptions

Options for uploading the files for the artifact. UploadFilesAndGenerateSasTokens is the default value. Possible values include: 'UploadFilesAndGenerateSasTokens', 'None'

Optional location

location: undefined | string

The location of the virtual machine.

Optional parameters

parameters: ParameterInfo[]

The parameters of the ARM template.

Optional virtualMachineName

virtualMachineName: undefined | string

The resource name of the virtual machine.

serializedName

serializedName: string = "GenerateArmTemplateRequest"

type

type: object

className

className: string = "GenerateArmTemplateRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fileUploadOptions

fileUploadOptions: object

serializedName

serializedName: string = "fileUploadOptions"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParameterInfo"

name

name: "Composite" = "Composite"

virtualMachineName

virtualMachineName: object

serializedName

serializedName: string = "virtualMachineName"

type

type: object

name

name: "String" = "String"

Const GenerateUploadUriParameter

GenerateUploadUriParameter: object

Properties for generating an upload URI.

Optional blobName

blobName: undefined | string

The blob name of the upload URI.

serializedName

serializedName: string = "GenerateUploadUriParameter"

type

type: object

className

className: string = "GenerateUploadUriParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobName

blobName: object

serializedName

serializedName: string = "blobName"

type

type: object

name

name: "String" = "String"

Const GenerateUploadUriResponse

GenerateUploadUriResponse: object

Response body for generating an upload URI.

Optional uploadUri

uploadUri: undefined | string

The upload URI for the VHD.

serializedName

serializedName: string = "GenerateUploadUriResponse"

type

type: object

className

className: string = "GenerateUploadUriResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

uploadUri

uploadUri: object

serializedName

serializedName: string = "uploadUri"

type

type: object

name

name: "String" = "String"

Const HourDetails

HourDetails: object

Properties of an hourly schedule.

Optional minute

minute: undefined | number

Minutes of the hour the schedule will run.

serializedName

serializedName: string = "HourDetails"

type

type: object

className

className: string = "HourDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

minute

minute: object

serializedName

serializedName: string = "minute"

type

type: object

name

name: "Number" = "Number"

Const HourDetailsFragment

HourDetailsFragment: object

Properties of an hourly schedule.

Optional minute

minute: undefined | number

Minutes of the hour the schedule will run.

serializedName

serializedName: string = "HourDetailsFragment"

type

type: object

className

className: string = "HourDetailsFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

minute

minute: object

serializedName

serializedName: string = "minute"

type

type: object

name

name: "Number" = "Number"

Const IdentityProperties

IdentityProperties: object

Properties of a managed identity

Optional clientSecretUrl

clientSecretUrl: undefined | string

The client secret URL of the identity.

Optional principalId

principalId: undefined | string

The principal id of resource identity.

Optional tenantId

tenantId: undefined | string

The tenant identifier of resource.

serializedName

serializedName: string = "IdentityProperties"

Optional type

type: object

Managed identity.

className

className: string = "IdentityProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientSecretUrl

clientSecretUrl: object

serializedName

serializedName: string = "clientSecretUrl"

type

type: object

name

name: "String" = "String"

principalId

principalId: object

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ImportLabVirtualMachineRequest

ImportLabVirtualMachineRequest: object

This represents the payload required to import a virtual machine from a different lab into the current one

Optional destinationVirtualMachineName

destinationVirtualMachineName: undefined | string

The name of the virtual machine in the destination lab

Optional sourceVirtualMachineResourceId

sourceVirtualMachineResourceId: undefined | string

The full resource ID of the virtual machine to be imported.

serializedName

serializedName: string = "ImportLabVirtualMachineRequest"

type

type: object

className

className: string = "ImportLabVirtualMachineRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destinationVirtualMachineName

destinationVirtualMachineName: object

serializedName

serializedName: string = "destinationVirtualMachineName"

type

type: object

name

name: "String" = "String"

sourceVirtualMachineResourceId

sourceVirtualMachineResourceId: object

serializedName

serializedName: string = "sourceVirtualMachineResourceId"

type

type: object

name

name: "String" = "String"

Const InboundNatRule

InboundNatRule: object

A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.

Optional backendPort

backendPort: undefined | number

The port to which the external traffic will be redirected.

Optional frontendPort

frontendPort: undefined | number

The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.

Optional transportProtocol

transportProtocol: TransportProtocol

The transport protocol for the endpoint. Possible values include: 'Tcp', 'Udp'

serializedName

serializedName: string = "InboundNatRule"

type

type: object

className

className: string = "InboundNatRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendPort

backendPort: object

serializedName

serializedName: string = "backendPort"

type

type: object

name

name: "Number" = "Number"

frontendPort

frontendPort: object

serializedName

serializedName: string = "frontendPort"

type

type: object

name

name: "Number" = "Number"

transportProtocol

transportProtocol: object

serializedName

serializedName: string = "transportProtocol"

type

type: object

name

name: "String" = "String"

Const InboundNatRuleFragment

InboundNatRuleFragment: object

A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.

Optional backendPort

backendPort: undefined | number

The port to which the external traffic will be redirected.

Optional frontendPort

frontendPort: undefined | number

The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.

Optional transportProtocol

transportProtocol: TransportProtocol

The transport protocol for the endpoint. Possible values include: 'Tcp', 'Udp'

serializedName

serializedName: string = "InboundNatRuleFragment"

type

type: object

className

className: string = "InboundNatRuleFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendPort

backendPort: object

serializedName

serializedName: string = "backendPort"

type

type: object

name

name: "Number" = "Number"

frontendPort

frontendPort: object

serializedName

serializedName: string = "frontendPort"

type

type: object

name

name: "Number" = "Number"

transportProtocol

transportProtocol: object

serializedName

serializedName: string = "transportProtocol"

type

type: object

name

name: "String" = "String"

Const Lab

Lab: object

A lab.

Optional announcement

The properties of any lab announcement associated with this lab

Optional artifactsStorageAccount

artifactsStorageAccount: undefined | string

The lab's artifact storage account. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdDate

createdDate: Date

The creation date of the lab. NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultPremiumStorageAccount

defaultPremiumStorageAccount: undefined | string

The lab's default premium storage account. NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultStorageAccount

defaultStorageAccount: undefined | string

The lab's default storage account. NOTE: This property will not be serialized. It can only be populated by the server.

Optional environmentPermission

environmentPermission: EnvironmentPermission

The access rights to be granted to the user when provisioning an environment. Possible values include: 'Reader', 'Contributor'

Optional extendedProperties

extendedProperties: undefined | object

Extended properties of the lab used for experimental features

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional labStorageType

labStorageType: StorageType

Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. Possible values include: 'Standard', 'Premium'

Optional loadBalancerId

loadBalancerId: undefined | string

The load balancer used to for lab VMs that use shared IP address. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional mandatoryArtifactsResourceIdsLinux

mandatoryArtifactsResourceIdsLinux: string[]

The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.

Optional mandatoryArtifactsResourceIdsWindows

mandatoryArtifactsResourceIdsWindows: string[]

The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkSecurityGroupId

networkSecurityGroupId: undefined | string

The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. NOTE: This property will not be serialized. It can only be populated by the server.

Optional premiumDataDiskStorageAccount

premiumDataDiskStorageAccount: undefined | string

The lab's premium data disk storage account. NOTE: This property will not be serialized. It can only be populated by the server.

Optional premiumDataDisks

premiumDataDisks: PremiumDataDisk

The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. Possible values include: 'Disabled', 'Enabled'

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicIpId

publicIpId: undefined | string

The public IP address for the lab's load balancer. NOTE: This property will not be serialized. It can only be populated by the server.

Optional support

The properties of any lab support message associated with this lab

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

Optional vaultName

vaultName: undefined | string

The lab's Key vault. NOTE: This property will not be serialized. It can only be populated by the server.

Optional vmCreationResourceGroup

vmCreationResourceGroup: undefined | string

The resource group in which lab virtual machines will be created in. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Lab"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Lab"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

announcement

announcement: object

serializedName

serializedName: string = "properties.announcement"

type

type: object

className

className: string = "LabAnnouncementProperties"

name

name: "Composite" = "Composite"

artifactsStorageAccount

artifactsStorageAccount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.artifactsStorageAccount"

type

type: object

name

name: "String" = "String"

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

defaultPremiumStorageAccount

defaultPremiumStorageAccount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultPremiumStorageAccount"

type

type: object

name

name: "String" = "String"

defaultStorageAccount

defaultStorageAccount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultStorageAccount"

type

type: object

name

name: "String" = "String"

environmentPermission

environmentPermission: object

serializedName

serializedName: string = "properties.environmentPermission"

type

type: object

name

name: "String" = "String"

extendedProperties

extendedProperties: object

serializedName

serializedName: string = "properties.extendedProperties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

labStorageType

labStorageType: object

serializedName

serializedName: string = "properties.labStorageType"

type

type: object

name

name: "String" = "String"

loadBalancerId

loadBalancerId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.loadBalancerId"

type

type: object

name

name: "String" = "String"

mandatoryArtifactsResourceIdsLinux

mandatoryArtifactsResourceIdsLinux: object

serializedName

serializedName: string = "properties.mandatoryArtifactsResourceIdsLinux"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

mandatoryArtifactsResourceIdsWindows

mandatoryArtifactsResourceIdsWindows: object

serializedName

serializedName: string = "properties.mandatoryArtifactsResourceIdsWindows"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

networkSecurityGroupId

networkSecurityGroupId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.networkSecurityGroupId"

type

type: object

name

name: "String" = "String"

premiumDataDiskStorageAccount

premiumDataDiskStorageAccount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.premiumDataDiskStorageAccount"

type

type: object

name

name: "String" = "String"

premiumDataDisks

premiumDataDisks: object

serializedName

serializedName: string = "properties.premiumDataDisks"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIpId

publicIpId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.publicIpId"

type

type: object

name

name: "String" = "String"

support

support: object

serializedName

serializedName: string = "properties.support"

type

type: object

className

className: string = "LabSupportProperties"

name

name: "Composite" = "Composite"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

vaultName

vaultName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.vaultName"

type

type: object

name

name: "String" = "String"

vmCreationResourceGroup

vmCreationResourceGroup: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.vmCreationResourceGroup"

type

type: object

name

name: "String" = "String"

Const LabAnnouncementProperties

LabAnnouncementProperties: object

Properties of a lab's announcement banner

Optional enabled

enabled: EnableStatus

Is the lab announcement active/enabled at this time?. Possible values include: 'Enabled', 'Disabled'

Optional expirationDate

expirationDate: Date

The time at which the announcement expires (null for never)

Optional expired

expired: undefined | false | true

Has this announcement expired?

Optional markdown

markdown: undefined | string

The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional title

title: undefined | string

The plain text title for the lab announcement

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LabAnnouncementProperties"

type

type: object

className

className: string = "LabAnnouncementProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "String" = "String"

expirationDate

expirationDate: object

serializedName

serializedName: string = "expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

expired

expired: object

serializedName

serializedName: string = "expired"

type

type: object

name

name: "Boolean" = "Boolean"

markdown

markdown: object

serializedName

serializedName: string = "markdown"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "provisioningState"

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "title"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "uniqueIdentifier"

type

type: object

name

name: "String" = "String"

Const LabAnnouncementPropertiesFragment

LabAnnouncementPropertiesFragment: object

Properties of a lab's announcement banner

Optional enabled

enabled: EnableStatus

Is the lab announcement active/enabled at this time?. Possible values include: 'Enabled', 'Disabled'

Optional expirationDate

expirationDate: Date

The time at which the announcement expires (null for never)

Optional expired

expired: undefined | false | true

Has this announcement expired?

Optional markdown

markdown: undefined | string

The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.

Optional title

title: undefined | string

The plain text title for the lab announcement

serializedName

serializedName: string = "LabAnnouncementPropertiesFragment"

type

type: object

className

className: string = "LabAnnouncementPropertiesFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "String" = "String"

expirationDate

expirationDate: object

serializedName

serializedName: string = "expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

expired

expired: object

serializedName

serializedName: string = "expired"

type

type: object

name

name: "Boolean" = "Boolean"

markdown

markdown: object

serializedName

serializedName: string = "markdown"

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "title"

type

type: object

name

name: "String" = "String"

Const LabCost

LabCost: object

A cost item.

Optional createdDate

createdDate: Date

The creation date of the cost.

Optional currencyCode

currencyCode: undefined | string

The currency code of the cost.

Optional endDateTime

endDateTime: Date

The end time of the cost data.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional labCostDetails

labCostDetails: LabCostDetailsProperties[]

The lab cost details component of the cost data. NOTE: This property will not be serialized. It can only be populated by the server.

Optional labCostSummary

labCostSummary: LabCostSummaryProperties

The lab cost summary component of the cost data. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceCosts

resourceCosts: LabResourceCostProperties[]

The resource cost component of the cost data. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startDateTime

startDateTime: Date

The start time of the cost data.

Optional tags

tags: undefined | object

The tags of the resource.

Optional targetCost

The target cost properties

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LabCost"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "LabCost"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdDate

createdDate: object

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

currencyCode

currencyCode: object

serializedName

serializedName: string = "properties.currencyCode"

type

type: object

name

name: "String" = "String"

endDateTime

endDateTime: object

serializedName

serializedName: string = "properties.endDateTime"

type

type: object

name

name: "DateTime" = "DateTime"

labCostDetails

labCostDetails: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.labCostDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LabCostDetailsProperties"

name

name: "Composite" = "Composite"

labCostSummary

labCostSummary: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.labCostSummary"

type

type: object

className

className: string = "LabCostSummaryProperties"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceCosts

resourceCosts: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceCosts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LabResourceCostProperties"

name

name: "Composite" = "Composite"

startDateTime

startDateTime: object

serializedName

serializedName: string = "properties.startDateTime"

type

type: object

name

name: "DateTime" = "DateTime"

targetCost

targetCost: object

serializedName

serializedName: string = "properties.targetCost"

type

type: object

className

className: string = "TargetCostProperties"

name

name: "Composite" = "Composite"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

Const LabCostDetailsProperties

LabCostDetailsProperties: object

The properties of a lab cost item.

Optional cost

cost: undefined | number

The cost component of the cost item.

Optional costType

costType: CostType

The type of the cost. Possible values include: 'Unavailable', 'Reported', 'Projected'

Optional date

date: Date

The date of the cost item.

serializedName

serializedName: string = "LabCostDetailsProperties"

type

type: object

className

className: string = "LabCostDetailsProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cost

cost: object

serializedName

serializedName: string = "cost"

type

type: object

name

name: "Number" = "Number"

costType

costType: object

serializedName

serializedName: string = "costType"

type

type: object

name

name: "String" = "String"

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "DateTime" = "DateTime"

Const LabCostSummaryProperties

LabCostSummaryProperties: object

The properties of the cost summary.

Optional estimatedLabCost

estimatedLabCost: undefined | number

The cost component of the cost item.

serializedName

serializedName: string = "LabCostSummaryProperties"

type

type: object

className

className: string = "LabCostSummaryProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

estimatedLabCost

estimatedLabCost: object

serializedName

serializedName: string = "estimatedLabCost"

type

type: object

name

name: "Number" = "Number"

Const LabFragment

LabFragment: object

A lab.

Optional announcement

The properties of any lab announcement associated with this lab

Optional environmentPermission

environmentPermission: EnvironmentPermission

The access rights to be granted to the user when provisioning an environment. Possible values include: 'Reader', 'Contributor'

Optional extendedProperties

extendedProperties: undefined | object

Extended properties of the lab used for experimental features

Optional labStorageType

labStorageType: StorageType

Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. Possible values include: 'Standard', 'Premium'

Optional mandatoryArtifactsResourceIdsLinux

mandatoryArtifactsResourceIdsLinux: string[]

The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.

Optional mandatoryArtifactsResourceIdsWindows

mandatoryArtifactsResourceIdsWindows: string[]

The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.

Optional premiumDataDisks

premiumDataDisks: PremiumDataDisk

The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. Possible values include: 'Disabled', 'Enabled'

Optional support

The properties of any lab support message associated with this lab

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "LabFragment"

type

type: object

className

className: string = "LabFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

announcement

announcement: object

serializedName

serializedName: string = "properties.announcement"

type

type: object

className

className: string = "LabAnnouncementPropertiesFragment"

name

name: "Composite" = "Composite"

environmentPermission

environmentPermission: object

serializedName

serializedName: string = "properties.environmentPermission"

type

type: object

name

name: "String" = "String"

extendedProperties

extendedProperties: object

serializedName

serializedName: string = "properties.extendedProperties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

labStorageType

labStorageType: object

serializedName

serializedName: string = "properties.labStorageType"

type

type: object

name

name: "String" = "String"

mandatoryArtifactsResourceIdsLinux

mandatoryArtifactsResourceIdsLinux: object

serializedName

serializedName: string = "properties.mandatoryArtifactsResourceIdsLinux"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

mandatoryArtifactsResourceIdsWindows

mandatoryArtifactsResourceIdsWindows: object

serializedName

serializedName: string = "properties.mandatoryArtifactsResourceIdsWindows"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

premiumDataDisks

premiumDataDisks: object

serializedName

serializedName: string = "properties.premiumDataDisks"

type

type: object

name

name: "String" = "String"

support

support: object

serializedName

serializedName: string = "properties.support"

type

type: object

className

className: string = "LabSupportPropertiesFragment"

name

name: "Composite" = "Composite"

Const LabList

LabList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "LabList"

__@iterator

  • __@iterator(): IterableIterator<Lab>
  • Iterator

    Returns IterableIterator<Lab>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Lab>[]): Lab[]
  • concat(...items: (T | ConcatArray<T>)[]): Lab[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Lab>[]

      Additional items to add to the end of array1.

    Returns Lab[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Lab[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Lab]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Lab]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Lab, index: number, array: Lab[]): boolean
        • Parameters

          • value: Lab
          • index: number
          • array: Lab[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Lab, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Lab

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Lab[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Lab, index: number, array: Lab[]): boolean
        • Parameters

          • value: Lab
          • index: number
          • array: Lab[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Lab, index: number, array: Lab[]): any
        • Parameters

          • value: Lab
          • index: number
          • array: Lab[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Lab[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Lab | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Lab, index: number, obj: Lab[]): boolean
        • Parameters

          • this: void
          • value: Lab
          • index: number
          • obj: Lab[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Lab, index: number, obj: Lab[]): boolean
        • Parameters

          • value: Lab
          • index: number
          • obj: Lab[]

          Returns boolean

    • Optional thisArg: any

    Returns Lab | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Lab, index: number, obj: Lab[]): boolean
        • Parameters

          • value: Lab
          • index: number
          • obj: Lab[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Lab, index: number, array: Lab[]): void
        • Parameters

          • value: Lab
          • index: number
          • array: Lab[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Lab, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Lab

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Lab, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Lab

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Lab, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Lab

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Lab, index: number, array: Lab[]): U
        • Parameters

          • value: Lab
          • index: number
          • array: Lab[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Lab | undefined
  • Removes the last element from an array and returns it.

    Returns Lab | undefined

push

  • push(...items: Lab[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Lab[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Lab
  • reduce(callbackfn: function, initialValue: Lab): Lab
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Lab, currentValue: Lab, currentIndex: number, array: Lab[]): Lab
        • Parameters

          • previousValue: Lab
          • currentValue: Lab
          • currentIndex: number
          • array: Lab[]

          Returns Lab

    Returns Lab

  • Parameters

    • callbackfn: function
        • (previousValue: Lab, currentValue: Lab, currentIndex: number, array: Lab[]): Lab
        • Parameters

          • previousValue: Lab
          • currentValue: Lab
          • currentIndex: number
          • array: Lab[]

          Returns Lab

    • initialValue: Lab

    Returns Lab

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Lab, currentIndex: number, array: Lab[]): U
        • Parameters

          • previousValue: U
          • currentValue: Lab
          • currentIndex: number
          • array: Lab[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Lab
  • reduceRight(callbackfn: function, initialValue: Lab): Lab
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Lab, currentValue: Lab, currentIndex: number, array: Lab[]): Lab
        • Parameters

          • previousValue: Lab
          • currentValue: Lab
          • currentIndex: number
          • array: Lab[]

          Returns Lab

    Returns Lab

  • Parameters

    • callbackfn: function
        • (previousValue: Lab, currentValue: Lab, currentIndex: number, array: Lab[]): Lab
        • Parameters

          • previousValue: Lab
          • currentValue: Lab
          • currentIndex: number
          • array: Lab[]

          Returns Lab

    • initialValue: Lab

    Returns Lab

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Lab, currentIndex: number, array: Lab[]): U
        • Parameters

          • previousValue: U
          • currentValue: Lab
          • currentIndex: number
          • array: Lab[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Lab[]
  • Reverses the elements in an Array.

    Returns Lab[]

shift

  • shift(): Lab | undefined
  • Removes the first element from an array and returns it.

    Returns Lab | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Lab[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Lab[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Lab, index: number, array: Lab[]): boolean
        • Parameters

          • value: Lab
          • index: number
          • array: Lab[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Lab[]
  • splice(start: number, deleteCount: number, ...items: Lab[]): Lab[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Lab[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Lab[]

      Elements to insert into the array in place of the deleted elements.

    Returns Lab[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Lab[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Lab[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Lab>
  • Returns an iterable of values in the array

    Returns IterableIterator<Lab>

type

type: object

className

className: string = "LabList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Lab"

name

name: "Composite" = "Composite"

Const LabResourceCostProperties

LabResourceCostProperties: object

The properties of a resource cost item.

Optional externalResourceId

externalResourceId: undefined | string

The ID of the external resource

Optional resourceCost

resourceCost: undefined | number

The cost component of the resource cost item.

Optional resourceId

resourceId: undefined | string

The ID of the resource

Optional resourceOwner

resourceOwner: undefined | string

The owner of the resource (ex. janedoe@microsoft.com)

Optional resourcePricingTier

resourcePricingTier: undefined | string

The category of the resource (ex. Premium_LRS, Standard_DS1)

Optional resourceStatus

resourceStatus: undefined | string

The status of the resource (ex. Active)

Optional resourceType

resourceType: undefined | string

The logical resource type (ex. virtualmachine, storageaccount)

Optional resourceUId

resourceUId: undefined | string

The unique identifier of the resource.

Optional resourcename

resourcename: undefined | string

The name of the resource.

serializedName

serializedName: string = "LabResourceCostProperties"

type

type: object

className

className: string = "LabResourceCostProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

externalResourceId

externalResourceId: object

serializedName

serializedName: string = "externalResourceId"

type

type: object

name

name: "String" = "String"

resourceCost

resourceCost: object

serializedName

serializedName: string = "resourceCost"

type

type: object

name

name: "Number" = "Number"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

resourceOwner

resourceOwner: object

serializedName

serializedName: string = "resourceOwner"

type

type: object

name

name: "String" = "String"

resourcePricingTier

resourcePricingTier: object

serializedName

serializedName: string = "resourcePricingTier"

type

type: object

name

name: "String" = "String"

resourceStatus

resourceStatus: object

serializedName

serializedName: string = "resourceStatus"

type

type: object

name

name: "String" = "String"

resourceType

resourceType: object

serializedName

serializedName: string = "resourceType"

type

type: object

name

name: "String" = "String"

resourceUId

resourceUId: object

serializedName

serializedName: string = "resourceUId"

type

type: object

name

name: "String" = "String"

resourcename

resourcename: object

serializedName

serializedName: string = "resourcename"

type

type: object

name

name: "String" = "String"

Const LabSupportProperties

LabSupportProperties: object

Properties of a lab's support banner

Optional enabled

enabled: EnableStatus

Is the lab support banner active/enabled at this time?. Possible values include: 'Enabled', 'Disabled'

Optional markdown

markdown: undefined | string

The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.

serializedName

serializedName: string = "LabSupportProperties"

type

type: object

className

className: string = "LabSupportProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "String" = "String"

markdown

markdown: object

serializedName

serializedName: string = "markdown"

type

type: object

name

name: "String" = "String"

Const LabSupportPropertiesFragment

LabSupportPropertiesFragment: object

Properties of a lab's support banner

Optional enabled

enabled: EnableStatus

Is the lab support banner active/enabled at this time?. Possible values include: 'Enabled', 'Disabled'

Optional markdown

markdown: undefined | string

The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.

serializedName

serializedName: string = "LabSupportPropertiesFragment"

type

type: object

className

className: string = "LabSupportPropertiesFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "String" = "String"

markdown

markdown: object

serializedName

serializedName: string = "markdown"

type

type: object

name

name: "String" = "String"

Const LabVhd

LabVhd: object

Properties of a VHD in the lab.

Optional id

id: undefined | string

The URI to the VHD.

serializedName

serializedName: string = "LabVhd"

type

type: object

className

className: string = "LabVhd"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const LabVhdList

LabVhdList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "LabVhdList"

__@iterator

  • __@iterator(): IterableIterator<LabVhd>
  • Iterator

    Returns IterableIterator<LabVhd>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LabVhd>[]): LabVhd[]
  • concat(...items: (T | ConcatArray<T>)[]): LabVhd[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LabVhd>[]

      Additional items to add to the end of array1.

    Returns LabVhd[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LabVhd[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LabVhd]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LabVhd]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LabVhd, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LabVhd

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LabVhd[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LabVhd[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LabVhd | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LabVhd, index: number, obj: LabVhd[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns LabVhd | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LabVhd, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LabVhd

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LabVhd, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LabVhd

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LabVhd, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LabVhd

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns LabVhd | undefined

push

  • push(...items: LabVhd[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LabVhd[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LabVhd
  • reduce(callbackfn: function, initialValue: LabVhd): LabVhd
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns LabVhd

  • Parameters

    Returns LabVhd

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LabVhd, currentIndex: number, array: LabVhd[]): U
        • Parameters

          • previousValue: U
          • currentValue: LabVhd
          • currentIndex: number
          • array: LabVhd[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LabVhd
  • reduceRight(callbackfn: function, initialValue: LabVhd): LabVhd
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns LabVhd

  • Parameters

    Returns LabVhd

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LabVhd, currentIndex: number, array: LabVhd[]): U
        • Parameters

          • previousValue: U
          • currentValue: LabVhd
          • currentIndex: number
          • array: LabVhd[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns LabVhd[]

shift

  • Removes the first element from an array and returns it.

    Returns LabVhd | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LabVhd[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LabVhd[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LabVhd[]
  • splice(start: number, deleteCount: number, ...items: LabVhd[]): LabVhd[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LabVhd[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LabVhd[]

      Elements to insert into the array in place of the deleted elements.

    Returns LabVhd[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LabVhd[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LabVhd[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LabVhd>
  • Returns an iterable of values in the array

    Returns IterableIterator<LabVhd>

type

type: object

className

className: string = "LabVhdList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LabVhd"

name

name: "Composite" = "Composite"

Const LabVirtualMachine

LabVirtualMachine: object

A virtual machine.

Optional allowClaim

allowClaim: undefined | false | true

Indicates whether another user can take ownership of the virtual machine

Optional applicableSchedule

applicableSchedule: ApplicableSchedule

The applicable schedule for the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

Optional artifactDeploymentStatus

artifactDeploymentStatus: ArtifactDeploymentStatusProperties

The artifact deployment status for the virtual machine.

Optional artifacts

The artifacts to be installed on the virtual machine.

Optional computeId

computeId: undefined | string

The resource identifier (Microsoft.Compute) of the virtual machine.

Optional computeVm

The compute virtual machine properties. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdByUser

createdByUser: undefined | string

The email address of creator of the virtual machine.

Optional createdByUserId

createdByUserId: undefined | string

The object identifier of the creator of the virtual machine.

Optional createdDate

createdDate: Date

The creation date of the virtual machine.

Optional customImageId

customImageId: undefined | string

The custom image identifier of the virtual machine.

Optional dataDiskParameters

dataDiskParameters: DataDiskProperties[]

New or existing data disks to attach to the virtual machine after creation

Optional disallowPublicIpAddress

disallowPublicIpAddress: undefined | false | true

Indicates whether the virtual machine is to be created without a public IP address.

Optional environmentId

environmentId: undefined | string

The resource ID of the environment that contains this virtual machine, if any.

Optional expirationDate

expirationDate: Date

The expiration date for VM.

Optional fqdn

fqdn: undefined | string

The fully-qualified domain name of the virtual machine.

Optional galleryImageReference

galleryImageReference: GalleryImageReference

The Microsoft Azure Marketplace image reference of the virtual machine.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isAuthenticationWithSshKey

isAuthenticationWithSshKey: undefined | false | true

Indicates whether this virtual machine uses an SSH key for authentication.

Optional labSubnetName

labSubnetName: undefined | string

The lab subnet name of the virtual machine.

Optional labVirtualNetworkId

labVirtualNetworkId: undefined | string

The lab virtual network identifier of the virtual machine.

Optional lastKnownPowerState

lastKnownPowerState: undefined | string

Last known compute power state captured in DTL

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkInterface

networkInterface: NetworkInterfaceProperties

The network interface properties.

Optional notes

notes: undefined | string

The notes of the virtual machine.

Optional osType

osType: undefined | string

The OS type of the virtual machine.

Optional ownerObjectId

ownerObjectId: undefined | string

The object identifier of the owner of the virtual machine.

Optional ownerUserPrincipalName

ownerUserPrincipalName: undefined | string

The user principal name of the virtual machine owner.

Optional password

password: undefined | string

The password of the virtual machine administrator.

Optional planId

planId: undefined | string

The id of the plan associated with the virtual machine image

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scheduleParameters

scheduleParameters: ScheduleCreationParameter[]

Virtual Machine schedules to be created

Optional size

size: undefined | string

The size of the virtual machine.

Optional sshKey

sshKey: undefined | string

The SSH key of the virtual machine administrator.

Optional storageType

storageType: undefined | string

Storage type to use for virtual machine (i.e. Standard, Premium).

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

Optional userName

userName: undefined | string

The user name of the virtual machine.

Optional virtualMachineCreationSource

virtualMachineCreationSource: VirtualMachineCreationSource

Tells source of creation of lab virtual machine. Output property only. Possible values include: 'FromCustomImage', 'FromGalleryImage'

serializedName

serializedName: string = "LabVirtualMachine"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "LabVirtualMachine"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowClaim

allowClaim: object

serializedName

serializedName: string = "properties.allowClaim"

type

type: object

name

name: "Boolean" = "Boolean"

applicableSchedule

applicableSchedule: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.applicableSchedule"

type

type: object

className

className: string = "ApplicableSchedule"

name

name: "Composite" = "Composite"

artifactDeploymentStatus

artifactDeploymentStatus: object

serializedName

serializedName: string = "properties.artifactDeploymentStatus"

type

type: object

className

className: string = "ArtifactDeploymentStatusProperties"

name

name: "Composite" = "Composite"

artifacts

artifacts: object

serializedName

serializedName: string = "properties.artifacts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactInstallProperties"

name

name: "Composite" = "Composite"

computeId

computeId: object

serializedName

serializedName: string = "properties.computeId"

type

type: object

name

name: "String" = "String"

computeVm

computeVm: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.computeVm"

type

type: object

className

className: string = "ComputeVmProperties"

name

name: "Composite" = "Composite"

createdByUser

createdByUser: object

serializedName

serializedName: string = "properties.createdByUser"

type

type: object

name

name: "String" = "String"

createdByUserId

createdByUserId: object

serializedName

serializedName: string = "properties.createdByUserId"

type

type: object

name

name: "String" = "String"

createdDate

createdDate: object

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

customImageId

customImageId: object

serializedName

serializedName: string = "properties.customImageId"

type

type: object

name

name: "String" = "String"

dataDiskParameters

dataDiskParameters: object

serializedName

serializedName: string = "properties.dataDiskParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataDiskProperties"

name

name: "Composite" = "Composite"

disallowPublicIpAddress

disallowPublicIpAddress: object

serializedName

serializedName: string = "properties.disallowPublicIpAddress"

type

type: object

name

name: "Boolean" = "Boolean"

environmentId

environmentId: object

serializedName

serializedName: string = "properties.environmentId"

type

type: object

name

name: "String" = "String"

expirationDate

expirationDate: object

serializedName

serializedName: string = "properties.expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

fqdn

fqdn: object

serializedName

serializedName: string = "properties.fqdn"

type

type: object

name

name: "String" = "String"

galleryImageReference

galleryImageReference: object

serializedName

serializedName: string = "properties.galleryImageReference"

type

type: object

className

className: string = "GalleryImageReference"

name

name: "Composite" = "Composite"

isAuthenticationWithSshKey

isAuthenticationWithSshKey: object

serializedName

serializedName: string = "properties.isAuthenticationWithSshKey"

type

type: object

name

name: "Boolean" = "Boolean"

labSubnetName

labSubnetName: object

serializedName

serializedName: string = "properties.labSubnetName"

type

type: object

name

name: "String" = "String"

labVirtualNetworkId

labVirtualNetworkId: object

serializedName

serializedName: string = "properties.labVirtualNetworkId"

type

type: object

name

name: "String" = "String"

lastKnownPowerState

lastKnownPowerState: object

serializedName

serializedName: string = "properties.lastKnownPowerState"

type

type: object

name

name: "String" = "String"

networkInterface

networkInterface: object

serializedName

serializedName: string = "properties.networkInterface"

type

type: object

className

className: string = "NetworkInterfaceProperties"

name

name: "Composite" = "Composite"

notes

notes: object

serializedName

serializedName: string = "properties.notes"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "properties.osType"

type

type: object

name

name: "String" = "String"

ownerObjectId

ownerObjectId: object

serializedName

serializedName: string = "properties.ownerObjectId"

type

type: object

name

name: "String" = "String"

ownerUserPrincipalName

ownerUserPrincipalName: object

serializedName

serializedName: string = "properties.ownerUserPrincipalName"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

planId

planId: object

serializedName

serializedName: string = "properties.planId"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

scheduleParameters

scheduleParameters: object

serializedName

serializedName: string = "properties.scheduleParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ScheduleCreationParameter"

name

name: "Composite" = "Composite"

size

size: object

serializedName

serializedName: string = "properties.size"

type

type: object

name

name: "String" = "String"

sshKey

sshKey: object

serializedName

serializedName: string = "properties.sshKey"

type

type: object

name

name: "String" = "String"

storageType

storageType: object

serializedName

serializedName: string = "properties.storageType"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

userName

userName: object

serializedName

serializedName: string = "properties.userName"

type

type: object

name

name: "String" = "String"

virtualMachineCreationSource

virtualMachineCreationSource: object

serializedName

serializedName: string = "properties.virtualMachineCreationSource"

type

type: object

name

name: "String" = "String"

Const LabVirtualMachineCreationParameter

LabVirtualMachineCreationParameter: object

Properties for creating a virtual machine.

Optional allowClaim

allowClaim: undefined | false | true

Indicates whether another user can take ownership of the virtual machine

Optional artifactDeploymentStatus

artifactDeploymentStatus: ArtifactDeploymentStatusProperties

The artifact deployment status for the virtual machine.

Optional artifacts

The artifacts to be installed on the virtual machine.

Optional bulkCreationParameters

bulkCreationParameters: BulkCreationParameters

The number of virtual machine instances to create.

Optional computeId

computeId: undefined | string

The resource identifier (Microsoft.Compute) of the virtual machine.

Optional createdByUser

createdByUser: undefined | string

The email address of creator of the virtual machine.

Optional createdByUserId

createdByUserId: undefined | string

The object identifier of the creator of the virtual machine.

Optional createdDate

createdDate: Date

The creation date of the virtual machine.

Optional customImageId

customImageId: undefined | string

The custom image identifier of the virtual machine.

Optional dataDiskParameters

dataDiskParameters: DataDiskProperties[]

New or existing data disks to attach to the virtual machine after creation

Optional disallowPublicIpAddress

disallowPublicIpAddress: undefined | false | true

Indicates whether the virtual machine is to be created without a public IP address.

Optional environmentId

environmentId: undefined | string

The resource ID of the environment that contains this virtual machine, if any.

Optional expirationDate

expirationDate: Date

The expiration date for VM.

Optional fqdn

fqdn: undefined | string

The fully-qualified domain name of the virtual machine.

Optional galleryImageReference

galleryImageReference: GalleryImageReference

The Microsoft Azure Marketplace image reference of the virtual machine.

Optional isAuthenticationWithSshKey

isAuthenticationWithSshKey: undefined | false | true

Indicates whether this virtual machine uses an SSH key for authentication.

Optional labSubnetName

labSubnetName: undefined | string

The lab subnet name of the virtual machine.

Optional labVirtualNetworkId

labVirtualNetworkId: undefined | string

The lab virtual network identifier of the virtual machine.

Optional lastKnownPowerState

lastKnownPowerState: undefined | string

Last known compute power state captured in DTL

Optional location

location: undefined | string

The location of the new virtual machine or environment

Optional name

name: undefined | string

The name of the virtual machine or environment

Optional networkInterface

networkInterface: NetworkInterfaceProperties

The network interface properties.

Optional notes

notes: undefined | string

The notes of the virtual machine.

Optional osType

osType: undefined | string

The OS type of the virtual machine.

Optional ownerObjectId

ownerObjectId: undefined | string

The object identifier of the owner of the virtual machine.

Optional ownerUserPrincipalName

ownerUserPrincipalName: undefined | string

The user principal name of the virtual machine owner.

Optional password

password: undefined | string

The password of the virtual machine administrator.

Optional planId

planId: undefined | string

The id of the plan associated with the virtual machine image

Optional scheduleParameters

scheduleParameters: ScheduleCreationParameter[]

Virtual Machine schedules to be created

Optional size

size: undefined | string

The size of the virtual machine.

Optional sshKey

sshKey: undefined | string

The SSH key of the virtual machine administrator.

Optional storageType

storageType: undefined | string

Storage type to use for virtual machine (i.e. Standard, Premium).

Optional tags

tags: undefined | object

The tags of the resource.

Optional userName

userName: undefined | string

The user name of the virtual machine.

Optional virtualMachineCreationSource

virtualMachineCreationSource: VirtualMachineCreationSource

Tells source of creation of lab virtual machine. Output property only. Possible values include: 'FromCustomImage', 'FromGalleryImage'

serializedName

serializedName: string = "LabVirtualMachineCreationParameter"

type

type: object

className

className: string = "LabVirtualMachineCreationParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowClaim

allowClaim: object

serializedName

serializedName: string = "properties.allowClaim"

type

type: object

name

name: "Boolean" = "Boolean"

artifactDeploymentStatus

artifactDeploymentStatus: object

serializedName

serializedName: string = "properties.artifactDeploymentStatus"

type

type: object

className

className: string = "ArtifactDeploymentStatusProperties"

name

name: "Composite" = "Composite"

artifacts

artifacts: object

serializedName

serializedName: string = "properties.artifacts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactInstallProperties"

name

name: "Composite" = "Composite"

bulkCreationParameters

bulkCreationParameters: object

serializedName

serializedName: string = "properties.bulkCreationParameters"

type

type: object

className

className: string = "BulkCreationParameters"

name

name: "Composite" = "Composite"

computeId

computeId: object

serializedName

serializedName: string = "properties.computeId"

type

type: object

name

name: "String" = "String"

createdByUser

createdByUser: object

serializedName

serializedName: string = "properties.createdByUser"

type

type: object

name

name: "String" = "String"

createdByUserId

createdByUserId: object

serializedName

serializedName: string = "properties.createdByUserId"

type

type: object

name

name: "String" = "String"

createdDate

createdDate: object

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

customImageId

customImageId: object

serializedName

serializedName: string = "properties.customImageId"

type

type: object

name

name: "String" = "String"

dataDiskParameters

dataDiskParameters: object

serializedName

serializedName: string = "properties.dataDiskParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataDiskProperties"

name

name: "Composite" = "Composite"

disallowPublicIpAddress

disallowPublicIpAddress: object

serializedName

serializedName: string = "properties.disallowPublicIpAddress"

type

type: object

name

name: "Boolean" = "Boolean"

environmentId

environmentId: object

serializedName

serializedName: string = "properties.environmentId"

type

type: object

name

name: "String" = "String"

expirationDate

expirationDate: object

serializedName

serializedName: string = "properties.expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

fqdn

fqdn: object

serializedName

serializedName: string = "properties.fqdn"

type

type: object

name

name: "String" = "String"

galleryImageReference

galleryImageReference: object

serializedName

serializedName: string = "properties.galleryImageReference"

type

type: object

className

className: string = "GalleryImageReference"

name

name: "Composite" = "Composite"

isAuthenticationWithSshKey

isAuthenticationWithSshKey: object

serializedName

serializedName: string = "properties.isAuthenticationWithSshKey"

type

type: object

name

name: "Boolean" = "Boolean"

labSubnetName

labSubnetName: object

serializedName

serializedName: string = "properties.labSubnetName"

type

type: object

name

name: "String" = "String"

labVirtualNetworkId

labVirtualNetworkId: object

serializedName

serializedName: string = "properties.labVirtualNetworkId"

type

type: object

name

name: "String" = "String"

lastKnownPowerState

lastKnownPowerState: object

serializedName

serializedName: string = "properties.lastKnownPowerState"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

networkInterface

networkInterface: object

serializedName

serializedName: string = "properties.networkInterface"

type

type: object

className

className: string = "NetworkInterfaceProperties"

name

name: "Composite" = "Composite"

notes

notes: object

serializedName

serializedName: string = "properties.notes"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "properties.osType"

type

type: object

name

name: "String" = "String"

ownerObjectId

ownerObjectId: object

serializedName

serializedName: string = "properties.ownerObjectId"

type

type: object

name

name: "String" = "String"

ownerUserPrincipalName

ownerUserPrincipalName: object

serializedName

serializedName: string = "properties.ownerUserPrincipalName"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

planId

planId: object

serializedName

serializedName: string = "properties.planId"

type

type: object

name

name: "String" = "String"

scheduleParameters

scheduleParameters: object

serializedName

serializedName: string = "properties.scheduleParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ScheduleCreationParameter"

name

name: "Composite" = "Composite"

size

size: object

serializedName

serializedName: string = "properties.size"

type

type: object

name

name: "String" = "String"

sshKey

sshKey: object

serializedName

serializedName: string = "properties.sshKey"

type

type: object

name

name: "String" = "String"

storageType

storageType: object

serializedName

serializedName: string = "properties.storageType"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

userName

userName: object

serializedName

serializedName: string = "properties.userName"

type

type: object

name

name: "String" = "String"

virtualMachineCreationSource

virtualMachineCreationSource: object

serializedName

serializedName: string = "properties.virtualMachineCreationSource"

type

type: object

name

name: "String" = "String"

Const LabVirtualMachineCreationParameterFragment

LabVirtualMachineCreationParameterFragment: object

Properties for creating a virtual machine.

Optional allowClaim

allowClaim: undefined | false | true

Indicates whether another user can take ownership of the virtual machine

Optional artifactDeploymentStatus

The artifact deployment status for the virtual machine.

Optional artifacts

The artifacts to be installed on the virtual machine.

Optional bulkCreationParameters

bulkCreationParameters: BulkCreationParametersFragment

The number of virtual machine instances to create.

Optional computeId

computeId: undefined | string

The resource identifier (Microsoft.Compute) of the virtual machine.

Optional createdByUser

createdByUser: undefined | string

The email address of creator of the virtual machine.

Optional createdByUserId

createdByUserId: undefined | string

The object identifier of the creator of the virtual machine.

Optional createdDate

createdDate: Date

The creation date of the virtual machine.

Optional customImageId

customImageId: undefined | string

The custom image identifier of the virtual machine.

Optional dataDiskParameters

dataDiskParameters: DataDiskPropertiesFragment[]

New or existing data disks to attach to the virtual machine after creation

Optional disallowPublicIpAddress

disallowPublicIpAddress: undefined | false | true

Indicates whether the virtual machine is to be created without a public IP address.

Optional environmentId

environmentId: undefined | string

The resource ID of the environment that contains this virtual machine, if any.

Optional expirationDate

expirationDate: Date

The expiration date for VM.

Optional fqdn

fqdn: undefined | string

The fully-qualified domain name of the virtual machine.

Optional galleryImageReference

galleryImageReference: GalleryImageReferenceFragment

The Microsoft Azure Marketplace image reference of the virtual machine.

Optional isAuthenticationWithSshKey

isAuthenticationWithSshKey: undefined | false | true

Indicates whether this virtual machine uses an SSH key for authentication.

Optional labSubnetName

labSubnetName: undefined | string

The lab subnet name of the virtual machine.

Optional labVirtualNetworkId

labVirtualNetworkId: undefined | string

The lab virtual network identifier of the virtual machine.

Optional lastKnownPowerState

lastKnownPowerState: undefined | string

Last known compute power state captured in DTL

Optional location

location: undefined | string

The location of the new virtual machine or environment

Optional name

name: undefined | string

The name of the virtual machine or environment

Optional networkInterface

The network interface properties.

Optional notes

notes: undefined | string

The notes of the virtual machine.

Optional osType

osType: undefined | string

The OS type of the virtual machine.

Optional ownerObjectId

ownerObjectId: undefined | string

The object identifier of the owner of the virtual machine.

Optional ownerUserPrincipalName

ownerUserPrincipalName: undefined | string

The user principal name of the virtual machine owner.

Optional password

password: undefined | string

The password of the virtual machine administrator.

Optional planId

planId: undefined | string

The id of the plan associated with the virtual machine image

Optional scheduleParameters

scheduleParameters: ScheduleCreationParameterFragment[]

Virtual Machine schedules to be created

Optional size

size: undefined | string

The size of the virtual machine.

Optional sshKey

sshKey: undefined | string

The SSH key of the virtual machine administrator.

Optional storageType

storageType: undefined | string

Storage type to use for virtual machine (i.e. Standard, Premium).

Optional tags

tags: undefined | object

The tags of the resource.

Optional userName

userName: undefined | string

The user name of the virtual machine.

Optional virtualMachineCreationSource

virtualMachineCreationSource: VirtualMachineCreationSource

Tells source of creation of lab virtual machine. Output property only. Possible values include: 'FromCustomImage', 'FromGalleryImage'

serializedName

serializedName: string = "LabVirtualMachineCreationParameterFragment"

type

type: object

className

className: string = "LabVirtualMachineCreationParameterFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowClaim

allowClaim: object

serializedName

serializedName: string = "properties.allowClaim"

type

type: object

name

name: "Boolean" = "Boolean"

artifactDeploymentStatus

artifactDeploymentStatus: object

serializedName

serializedName: string = "properties.artifactDeploymentStatus"

type

type: object

className

className: string = "ArtifactDeploymentStatusPropertiesFragment"

name

name: "Composite" = "Composite"

artifacts

artifacts: object

serializedName

serializedName: string = "properties.artifacts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactInstallPropertiesFragment"

name

name: "Composite" = "Composite"

bulkCreationParameters

bulkCreationParameters: object

serializedName

serializedName: string = "properties.bulkCreationParameters"

type

type: object

className

className: string = "BulkCreationParametersFragment"

name

name: "Composite" = "Composite"

computeId

computeId: object

serializedName

serializedName: string = "properties.computeId"

type

type: object

name

name: "String" = "String"

createdByUser

createdByUser: object

serializedName

serializedName: string = "properties.createdByUser"

type

type: object

name

name: "String" = "String"

createdByUserId

createdByUserId: object

serializedName

serializedName: string = "properties.createdByUserId"

type

type: object

name

name: "String" = "String"

createdDate

createdDate: object

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

customImageId

customImageId: object

serializedName

serializedName: string = "properties.customImageId"

type

type: object

name

name: "String" = "String"

dataDiskParameters

dataDiskParameters: object

serializedName

serializedName: string = "properties.dataDiskParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataDiskPropertiesFragment"

name

name: "Composite" = "Composite"

disallowPublicIpAddress

disallowPublicIpAddress: object

serializedName

serializedName: string = "properties.disallowPublicIpAddress"

type

type: object

name

name: "Boolean" = "Boolean"

environmentId

environmentId: object

serializedName

serializedName: string = "properties.environmentId"

type

type: object

name

name: "String" = "String"

expirationDate

expirationDate: object

serializedName

serializedName: string = "properties.expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

fqdn

fqdn: object

serializedName

serializedName: string = "properties.fqdn"

type

type: object

name

name: "String" = "String"

galleryImageReference

galleryImageReference: object

serializedName

serializedName: string = "properties.galleryImageReference"

type

type: object

className

className: string = "GalleryImageReferenceFragment"

name

name: "Composite" = "Composite"

isAuthenticationWithSshKey

isAuthenticationWithSshKey: object

serializedName

serializedName: string = "properties.isAuthenticationWithSshKey"

type

type: object

name

name: "Boolean" = "Boolean"

labSubnetName

labSubnetName: object

serializedName

serializedName: string = "properties.labSubnetName"

type

type: object

name

name: "String" = "String"

labVirtualNetworkId

labVirtualNetworkId: object

serializedName

serializedName: string = "properties.labVirtualNetworkId"

type

type: object

name

name: "String" = "String"

lastKnownPowerState

lastKnownPowerState: object

serializedName

serializedName: string = "properties.lastKnownPowerState"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

networkInterface

networkInterface: object

serializedName

serializedName: string = "properties.networkInterface"

type

type: object

className

className: string = "NetworkInterfacePropertiesFragment"

name

name: "Composite" = "Composite"

notes

notes: object

serializedName

serializedName: string = "properties.notes"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "properties.osType"

type

type: object

name

name: "String" = "String"

ownerObjectId

ownerObjectId: object

serializedName

serializedName: string = "properties.ownerObjectId"

type

type: object

name

name: "String" = "String"

ownerUserPrincipalName

ownerUserPrincipalName: object

serializedName

serializedName: string = "properties.ownerUserPrincipalName"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

planId

planId: object

serializedName

serializedName: string = "properties.planId"

type

type: object

name

name: "String" = "String"

scheduleParameters

scheduleParameters: object

serializedName

serializedName: string = "properties.scheduleParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ScheduleCreationParameterFragment"

name

name: "Composite" = "Composite"

size

size: object

serializedName

serializedName: string = "properties.size"

type

type: object

name

name: "String" = "String"

sshKey

sshKey: object

serializedName

serializedName: string = "properties.sshKey"

type

type: object

name

name: "String" = "String"

storageType

storageType: object

serializedName

serializedName: string = "properties.storageType"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

userName

userName: object

serializedName

serializedName: string = "properties.userName"

type

type: object

name

name: "String" = "String"

virtualMachineCreationSource

virtualMachineCreationSource: object

serializedName

serializedName: string = "properties.virtualMachineCreationSource"

type

type: object

name

name: "String" = "String"

Const LabVirtualMachineFragment

LabVirtualMachineFragment: object

A virtual machine.

Optional allowClaim

allowClaim: undefined | false | true

Indicates whether another user can take ownership of the virtual machine

Optional artifactDeploymentStatus

The artifact deployment status for the virtual machine.

Optional artifacts

The artifacts to be installed on the virtual machine.

Optional computeId

computeId: undefined | string

The resource identifier (Microsoft.Compute) of the virtual machine.

Optional createdByUser

createdByUser: undefined | string

The email address of creator of the virtual machine.

Optional createdByUserId

createdByUserId: undefined | string

The object identifier of the creator of the virtual machine.

Optional createdDate

createdDate: Date

The creation date of the virtual machine.

Optional customImageId

customImageId: undefined | string

The custom image identifier of the virtual machine.

Optional dataDiskParameters

dataDiskParameters: DataDiskPropertiesFragment[]

New or existing data disks to attach to the virtual machine after creation

Optional disallowPublicIpAddress

disallowPublicIpAddress: undefined | false | true

Indicates whether the virtual machine is to be created without a public IP address.

Optional environmentId

environmentId: undefined | string

The resource ID of the environment that contains this virtual machine, if any.

Optional expirationDate

expirationDate: Date

The expiration date for VM.

Optional fqdn

fqdn: undefined | string

The fully-qualified domain name of the virtual machine.

Optional galleryImageReference

galleryImageReference: GalleryImageReferenceFragment

The Microsoft Azure Marketplace image reference of the virtual machine.

Optional isAuthenticationWithSshKey

isAuthenticationWithSshKey: undefined | false | true

Indicates whether this virtual machine uses an SSH key for authentication.

Optional labSubnetName

labSubnetName: undefined | string

The lab subnet name of the virtual machine.

Optional labVirtualNetworkId

labVirtualNetworkId: undefined | string

The lab virtual network identifier of the virtual machine.

Optional lastKnownPowerState

lastKnownPowerState: undefined | string

Last known compute power state captured in DTL

Optional networkInterface

The network interface properties.

Optional notes

notes: undefined | string

The notes of the virtual machine.

Optional osType

osType: undefined | string

The OS type of the virtual machine.

Optional ownerObjectId

ownerObjectId: undefined | string

The object identifier of the owner of the virtual machine.

Optional ownerUserPrincipalName

ownerUserPrincipalName: undefined | string

The user principal name of the virtual machine owner.

Optional password

password: undefined | string

The password of the virtual machine administrator.

Optional planId

planId: undefined | string

The id of the plan associated with the virtual machine image

Optional scheduleParameters

scheduleParameters: ScheduleCreationParameterFragment[]

Virtual Machine schedules to be created

Optional size

size: undefined | string

The size of the virtual machine.

Optional sshKey

sshKey: undefined | string

The SSH key of the virtual machine administrator.

Optional storageType

storageType: undefined | string

Storage type to use for virtual machine (i.e. Standard, Premium).

Optional tags

tags: undefined | object

The tags of the resource.

Optional userName

userName: undefined | string

The user name of the virtual machine.

Optional virtualMachineCreationSource

virtualMachineCreationSource: VirtualMachineCreationSource

Tells source of creation of lab virtual machine. Output property only. Possible values include: 'FromCustomImage', 'FromGalleryImage'

serializedName

serializedName: string = "LabVirtualMachineFragment"

type

type: object

className

className: string = "LabVirtualMachineFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowClaim

allowClaim: object

serializedName

serializedName: string = "properties.allowClaim"

type

type: object

name

name: "Boolean" = "Boolean"

artifactDeploymentStatus

artifactDeploymentStatus: object

serializedName

serializedName: string = "properties.artifactDeploymentStatus"

type

type: object

className

className: string = "ArtifactDeploymentStatusPropertiesFragment"

name

name: "Composite" = "Composite"

artifacts

artifacts: object

serializedName

serializedName: string = "properties.artifacts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactInstallPropertiesFragment"

name

name: "Composite" = "Composite"

computeId

computeId: object

serializedName

serializedName: string = "properties.computeId"

type

type: object

name

name: "String" = "String"

createdByUser

createdByUser: object

serializedName

serializedName: string = "properties.createdByUser"

type

type: object

name

name: "String" = "String"

createdByUserId

createdByUserId: object

serializedName

serializedName: string = "properties.createdByUserId"

type

type: object

name

name: "String" = "String"

createdDate

createdDate: object

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

customImageId

customImageId: object

serializedName

serializedName: string = "properties.customImageId"

type

type: object

name

name: "String" = "String"

dataDiskParameters

dataDiskParameters: object

serializedName

serializedName: string = "properties.dataDiskParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataDiskPropertiesFragment"

name

name: "Composite" = "Composite"

disallowPublicIpAddress

disallowPublicIpAddress: object

serializedName

serializedName: string = "properties.disallowPublicIpAddress"

type

type: object

name

name: "Boolean" = "Boolean"

environmentId

environmentId: object

serializedName

serializedName: string = "properties.environmentId"

type

type: object

name

name: "String" = "String"

expirationDate

expirationDate: object

serializedName

serializedName: string = "properties.expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

fqdn

fqdn: object

serializedName

serializedName: string = "properties.fqdn"

type

type: object

name

name: "String" = "String"

galleryImageReference

galleryImageReference: object

serializedName

serializedName: string = "properties.galleryImageReference"

type

type: object

className

className: string = "GalleryImageReferenceFragment"

name

name: "Composite" = "Composite"

isAuthenticationWithSshKey

isAuthenticationWithSshKey: object

serializedName

serializedName: string = "properties.isAuthenticationWithSshKey"

type

type: object

name

name: "Boolean" = "Boolean"

labSubnetName

labSubnetName: object

serializedName

serializedName: string = "properties.labSubnetName"

type

type: object

name

name: "String" = "String"

labVirtualNetworkId

labVirtualNetworkId: object

serializedName

serializedName: string = "properties.labVirtualNetworkId"

type

type: object

name

name: "String" = "String"

lastKnownPowerState

lastKnownPowerState: object

serializedName

serializedName: string = "properties.lastKnownPowerState"

type

type: object

name

name: "String" = "String"

networkInterface

networkInterface: object

serializedName

serializedName: string = "properties.networkInterface"

type

type: object

className

className: string = "NetworkInterfacePropertiesFragment"

name

name: "Composite" = "Composite"

notes

notes: object

serializedName

serializedName: string = "properties.notes"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "properties.osType"

type

type: object

name

name: "String" = "String"

ownerObjectId

ownerObjectId: object

serializedName

serializedName: string = "properties.ownerObjectId"

type

type: object

name

name: "String" = "String"

ownerUserPrincipalName

ownerUserPrincipalName: object

serializedName

serializedName: string = "properties.ownerUserPrincipalName"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

planId

planId: object

serializedName

serializedName: string = "properties.planId"

type

type: object

name

name: "String" = "String"

scheduleParameters

scheduleParameters: object

serializedName

serializedName: string = "properties.scheduleParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ScheduleCreationParameterFragment"

name

name: "Composite" = "Composite"

size

size: object

serializedName

serializedName: string = "properties.size"

type

type: object

name

name: "String" = "String"

sshKey

sshKey: object

serializedName

serializedName: string = "properties.sshKey"

type

type: object

name

name: "String" = "String"

storageType

storageType: object

serializedName

serializedName: string = "properties.storageType"

type

type: object

name

name: "String" = "String"

userName

userName: object

serializedName

serializedName: string = "properties.userName"

type

type: object

name

name: "String" = "String"

virtualMachineCreationSource

virtualMachineCreationSource: object

serializedName

serializedName: string = "properties.virtualMachineCreationSource"

type

type: object

name

name: "String" = "String"

Const LabVirtualMachineList

LabVirtualMachineList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "LabVirtualMachineList"

__@iterator

  • Iterator

    Returns IterableIterator<LabVirtualMachine>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LabVirtualMachine>[]

      Additional items to add to the end of array1.

    Returns LabVirtualMachine[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LabVirtualMachine[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LabVirtualMachine]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LabVirtualMachine, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LabVirtualMachine

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LabVirtualMachine[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LabVirtualMachine[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LabVirtualMachine | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns LabVirtualMachine | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LabVirtualMachine, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LabVirtualMachine

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LabVirtualMachine

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LabVirtualMachine, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LabVirtualMachine

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns LabVirtualMachine | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LabVirtualMachine

  • Parameters

    Returns LabVirtualMachine

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LabVirtualMachine

  • Parameters

    Returns LabVirtualMachine

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns LabVirtualMachine[]

shift

  • Removes the first element from an array and returns it.

    Returns LabVirtualMachine | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LabVirtualMachine[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LabVirtualMachine[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LabVirtualMachine[]

      Elements to insert into the array in place of the deleted elements.

    Returns LabVirtualMachine[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<LabVirtualMachine>

type

type: object

className

className: string = "LabVirtualMachineList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LabVirtualMachine"

name

name: "Composite" = "Composite"

Const LinuxOsInfo

LinuxOsInfo: object

Information about a Linux OS.

Optional linuxOsState

linuxOsState: LinuxOsState

The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). Possible values include: 'NonDeprovisioned', 'DeprovisionRequested', 'DeprovisionApplied'

serializedName

serializedName: string = "LinuxOsInfo"

type

type: object

className

className: string = "LinuxOsInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

linuxOsState

linuxOsState: object

serializedName

serializedName: string = "linuxOsState"

type

type: object

name

name: "String" = "String"

Const LinuxOsInfoFragment

LinuxOsInfoFragment: object

Information about a Linux OS.

Optional linuxOsState

linuxOsState: LinuxOsState

The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). Possible values include: 'NonDeprovisioned', 'DeprovisionRequested', 'DeprovisionApplied'

serializedName

serializedName: string = "LinuxOsInfoFragment"

type

type: object

className

className: string = "LinuxOsInfoFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

linuxOsState

linuxOsState: object

serializedName

serializedName: string = "linuxOsState"

type

type: object

name

name: "String" = "String"

Const NetworkInterfaceProperties

NetworkInterfaceProperties: object

Properties of a network interface.

Optional dnsName

dnsName: undefined | string

The DNS name.

Optional privateIpAddress

privateIpAddress: undefined | string

The private IP address.

Optional publicIpAddress

publicIpAddress: undefined | string

The public IP address.

Optional publicIpAddressId

publicIpAddressId: undefined | string

The resource ID of the public IP address.

Optional rdpAuthority

rdpAuthority: undefined | string

The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).

Optional sharedPublicIpAddressConfiguration

sharedPublicIpAddressConfiguration: SharedPublicIpAddressConfiguration

The configuration for sharing a public IP address across multiple virtual machines.

Optional sshAuthority

sshAuthority: undefined | string

The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.

Optional subnetId

subnetId: undefined | string

The resource ID of the sub net.

Optional virtualNetworkId

virtualNetworkId: undefined | string

The resource ID of the virtual network.

serializedName

serializedName: string = "NetworkInterfaceProperties"

type

type: object

className

className: string = "NetworkInterfaceProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dnsName

dnsName: object

serializedName

serializedName: string = "dnsName"

type

type: object

name

name: "String" = "String"

privateIpAddress

privateIpAddress: object

serializedName

serializedName: string = "privateIpAddress"

type

type: object

name

name: "String" = "String"

publicIpAddress

publicIpAddress: object

serializedName

serializedName: string = "publicIpAddress"

type

type: object

name

name: "String" = "String"

publicIpAddressId

publicIpAddressId: object

serializedName

serializedName: string = "publicIpAddressId"

type

type: object

name

name: "String" = "String"

rdpAuthority

rdpAuthority: object

serializedName

serializedName: string = "rdpAuthority"

type

type: object

name

name: "String" = "String"

sharedPublicIpAddressConfiguration

sharedPublicIpAddressConfiguration: object

serializedName

serializedName: string = "sharedPublicIpAddressConfiguration"

type

type: object

className

className: string = "SharedPublicIpAddressConfiguration"

name

name: "Composite" = "Composite"

sshAuthority

sshAuthority: object

serializedName

serializedName: string = "sshAuthority"

type

type: object

name

name: "String" = "String"

subnetId

subnetId: object

serializedName

serializedName: string = "subnetId"

type

type: object

name

name: "String" = "String"

virtualNetworkId

virtualNetworkId: object

serializedName

serializedName: string = "virtualNetworkId"

type

type: object

name

name: "String" = "String"

Const NetworkInterfacePropertiesFragment

NetworkInterfacePropertiesFragment: object

Properties of a network interface.

Optional dnsName

dnsName: undefined | string

The DNS name.

Optional privateIpAddress

privateIpAddress: undefined | string

The private IP address.

Optional publicIpAddress

publicIpAddress: undefined | string

The public IP address.

Optional publicIpAddressId

publicIpAddressId: undefined | string

The resource ID of the public IP address.

Optional rdpAuthority

rdpAuthority: undefined | string

The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).

Optional sharedPublicIpAddressConfiguration

sharedPublicIpAddressConfiguration: SharedPublicIpAddressConfigurationFragment

The configuration for sharing a public IP address across multiple virtual machines.

Optional sshAuthority

sshAuthority: undefined | string

The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.

Optional subnetId

subnetId: undefined | string

The resource ID of the sub net.

Optional virtualNetworkId

virtualNetworkId: undefined | string

The resource ID of the virtual network.

serializedName

serializedName: string = "NetworkInterfacePropertiesFragment"

type

type: object

className

className: string = "NetworkInterfacePropertiesFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dnsName

dnsName: object

serializedName

serializedName: string = "dnsName"

type

type: object

name

name: "String" = "String"

privateIpAddress

privateIpAddress: object

serializedName

serializedName: string = "privateIpAddress"

type

type: object

name

name: "String" = "String"

publicIpAddress

publicIpAddress: object

serializedName

serializedName: string = "publicIpAddress"

type

type: object

name

name: "String" = "String"

publicIpAddressId

publicIpAddressId: object

serializedName

serializedName: string = "publicIpAddressId"

type

type: object

name

name: "String" = "String"

rdpAuthority

rdpAuthority: object

serializedName

serializedName: string = "rdpAuthority"

type

type: object

name

name: "String" = "String"

sharedPublicIpAddressConfiguration

sharedPublicIpAddressConfiguration: object

serializedName

serializedName: string = "sharedPublicIpAddressConfiguration"

type

type: object

className

className: string = "SharedPublicIpAddressConfigurationFragment"

name

name: "Composite" = "Composite"

sshAuthority

sshAuthority: object

serializedName

serializedName: string = "sshAuthority"

type

type: object

name

name: "String" = "String"

subnetId

subnetId: object

serializedName

serializedName: string = "subnetId"

type

type: object

name

name: "String" = "String"

virtualNetworkId

virtualNetworkId: object

serializedName

serializedName: string = "virtualNetworkId"

type

type: object

name

name: "String" = "String"

Const NotificationChannel

NotificationChannel: object

A notification.

Optional createdDate

createdDate: Date

The creation date of the notification channel. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

Description of notification.

Optional emailRecipient

emailRecipient: undefined | string

The email recipient to send notifications to (can be a list of semi-colon separated email addresses).

Optional events

events: Event[]

The list of event for which this notification is enabled.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional notificationLocale

notificationLocale: undefined | string

The locale to use when sending a notification (fallback for unsupported languages is EN).

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

Optional webHookUrl

webHookUrl: undefined | string

The webhook URL to send notifications to.

serializedName

serializedName: string = "NotificationChannel"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "NotificationChannel"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

emailRecipient

emailRecipient: object

serializedName

serializedName: string = "properties.emailRecipient"

type

type: object

name

name: "String" = "String"

events

events: object

serializedName

serializedName: string = "properties.events"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Event"

name

name: "Composite" = "Composite"

notificationLocale

notificationLocale: object

serializedName

serializedName: string = "properties.notificationLocale"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

webHookUrl

webHookUrl: object

serializedName

serializedName: string = "properties.webHookUrl"

type

type: object

name

name: "String" = "String"

Const NotificationChannelFragment

NotificationChannelFragment: object

A notification.

Optional description

description: undefined | string

Description of notification.

Optional emailRecipient

emailRecipient: undefined | string

The email recipient to send notifications to (can be a list of semi-colon separated email addresses).

Optional events

events: EventFragment[]

The list of event for which this notification is enabled.

Optional notificationLocale

notificationLocale: undefined | string

The locale to use when sending a notification (fallback for unsupported languages is EN).

Optional tags

tags: undefined | object

The tags of the resource.

Optional webHookUrl

webHookUrl: undefined | string

The webhook URL to send notifications to.

serializedName

serializedName: string = "NotificationChannelFragment"

type

type: object

className

className: string = "NotificationChannelFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

emailRecipient

emailRecipient: object

serializedName

serializedName: string = "properties.emailRecipient"

type

type: object

name

name: "String" = "String"

events

events: object

serializedName

serializedName: string = "properties.events"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EventFragment"

name

name: "Composite" = "Composite"

notificationLocale

notificationLocale: object

serializedName

serializedName: string = "properties.notificationLocale"

type

type: object

name

name: "String" = "String"

webHookUrl

webHookUrl: object

serializedName

serializedName: string = "properties.webHookUrl"

type

type: object

name

name: "String" = "String"

Const NotificationChannelList

NotificationChannelList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "NotificationChannelList"

__@iterator

  • Iterator

    Returns IterableIterator<NotificationChannel>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NotificationChannel>[]

      Additional items to add to the end of array1.

    Returns NotificationChannel[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NotificationChannel[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NotificationChannel]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NotificationChannel

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NotificationChannel[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NotificationChannel[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NotificationChannel | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns NotificationChannel | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NotificationChannel

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NotificationChannel

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NotificationChannel

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns NotificationChannel | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns NotificationChannel

  • Parameters

    Returns NotificationChannel

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns NotificationChannel

  • Parameters

    Returns NotificationChannel

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns NotificationChannel[]

shift

  • Removes the first element from an array and returns it.

    Returns NotificationChannel | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NotificationChannel[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NotificationChannel[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NotificationChannel[]

      Elements to insert into the array in place of the deleted elements.

    Returns NotificationChannel[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<NotificationChannel>

type

type: object

className

className: string = "NotificationChannelList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NotificationChannel"

name

name: "Composite" = "Composite"

Const NotificationSettings

NotificationSettings: object

Notification settings for a schedule.

Optional emailRecipient

emailRecipient: undefined | string

The email recipient to send notifications to (can be a list of semi-colon separated email addresses).

Optional notificationLocale

notificationLocale: undefined | string

The locale to use when sending a notification (fallback for unsupported languages is EN).

Optional status

status: EnableStatus

If notifications are enabled for this schedule (i.e. Enabled, Disabled). Possible values include: 'Enabled', 'Disabled'

Optional timeInMinutes

timeInMinutes: undefined | number

Time in minutes before event at which notification will be sent.

Optional webhookUrl

webhookUrl: undefined | string

The webhook URL to which the notification will be sent.

serializedName

serializedName: string = "NotificationSettings"

type

type: object

className

className: string = "NotificationSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

emailRecipient

emailRecipient: object

serializedName

serializedName: string = "emailRecipient"

type

type: object

name

name: "String" = "String"

notificationLocale

notificationLocale: object

serializedName

serializedName: string = "notificationLocale"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

timeInMinutes

timeInMinutes: object

serializedName

serializedName: string = "timeInMinutes"

type

type: object

name

name: "Number" = "Number"

webhookUrl

webhookUrl: object

serializedName

serializedName: string = "webhookUrl"

type

type: object

name

name: "String" = "String"

Const NotificationSettingsFragment

NotificationSettingsFragment: object

Notification settings for a schedule.

Optional emailRecipient

emailRecipient: undefined | string

The email recipient to send notifications to (can be a list of semi-colon separated email addresses).

Optional notificationLocale

notificationLocale: undefined | string

The locale to use when sending a notification (fallback for unsupported languages is EN).

Optional status

status: EnableStatus

If notifications are enabled for this schedule (i.e. Enabled, Disabled). Possible values include: 'Enabled', 'Disabled'

Optional timeInMinutes

timeInMinutes: undefined | number

Time in minutes before event at which notification will be sent.

Optional webhookUrl

webhookUrl: undefined | string

The webhook URL to which the notification will be sent.

serializedName

serializedName: string = "NotificationSettingsFragment"

type

type: object

className

className: string = "NotificationSettingsFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

emailRecipient

emailRecipient: object

serializedName

serializedName: string = "emailRecipient"

type

type: object

name

name: "String" = "String"

notificationLocale

notificationLocale: object

serializedName

serializedName: string = "notificationLocale"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

timeInMinutes

timeInMinutes: object

serializedName

serializedName: string = "timeInMinutes"

type

type: object

name

name: "Number" = "Number"

webhookUrl

webhookUrl: object

serializedName

serializedName: string = "webhookUrl"

type

type: object

name

name: "String" = "String"

Const NotifyParameters

NotifyParameters: object

Properties for generating a Notification.

Optional eventName

The type of event (i.e. AutoShutdown, Cost). Possible values include: 'AutoShutdown', 'Cost'

Optional jsonPayload

jsonPayload: undefined | string

Properties for the notification in json format.

serializedName

serializedName: string = "NotifyParameters"

type

type: object

className

className: string = "NotifyParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eventName

eventName: object

serializedName

serializedName: string = "eventName"

type

type: object

name

name: "String" = "String"

jsonPayload

jsonPayload: object

serializedName

serializedName: string = "jsonPayload"

type

type: object

name

name: "String" = "String"

Const OperationError

OperationError: object

Error details for the operation in case of a failure.

Optional code

code: undefined | string

The error code of the operation error.

Optional message

message: undefined | string

The error message of the operation error.

serializedName

serializedName: string = "OperationError"

type

type: object

className

className: string = "OperationError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const OperationMetadata

OperationMetadata: object

The REST API operation supported by DevTestLab ResourceProvider.

Optional display

The object that describes the operations

Optional name

name: undefined | string

Operation name: {provider}/{resource}/{operation}

serializedName

serializedName: string = "OperationMetadata"

type

type: object

className

className: string = "OperationMetadata"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationMetadataDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const OperationMetadataDisplay

OperationMetadataDisplay: object

The object that describes the operations

Optional description

description: undefined | string

Friendly name of the operation

Optional operation

operation: undefined | string

Operation type: read, write, delete, listKeys/action, etc.

Optional provider

provider: undefined | string

Friendly name of the resource provider

Optional resource

resource: undefined | string

Resource type on which the operation is performed.

serializedName

serializedName: string = "OperationMetadataDisplay"

type

type: object

className

className: string = "OperationMetadataDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OperationResult

OperationResult: object

An Operation Result

Optional error

Error details for the operation in case of a failure.

Optional status

status: undefined | string

The operation status.

Optional statusCode

statusCode: HttpStatusCode

The status code for the operation. Possible values include: 'Continue', 'SwitchingProtocols', 'OK', 'Created', 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', 'PartialContent', 'MultipleChoices', 'MovedPermanently', 'Redirect', 'SeeOther', 'NotModified', 'UseProxy', 'Unused', 'TemporaryRedirect', 'BadRequest', 'Unauthorized', 'PaymentRequired', 'Forbidden', 'NotFound', 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', 'PreconditionFailed', 'RequestEntityTooLarge', 'RequestUriTooLong', 'UnsupportedMediaType', 'RequestedRangeNotSatisfiable', 'ExpectationFailed', 'UpgradeRequired', 'InternalServerError', 'NotImplemented', 'BadGateway', 'ServiceUnavailable', 'GatewayTimeout', 'HttpVersionNotSupported'

serializedName

serializedName: string = "OperationResult"

type

type: object

className

className: string = "OperationResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "OperationError"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

statusCode

statusCode: object

serializedName

serializedName: string = "statusCode"

type

type: object

name

name: "String" = "String"

Const ParameterInfo

ParameterInfo: object

Information about an artifact's parameter.

Optional name

name: undefined | string

The name of the artifact parameter.

Optional value

value: undefined | string

The value of the artifact parameter.

serializedName

serializedName: string = "ParameterInfo"

type

type: object

className

className: string = "ParameterInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ParametersValueFileInfo

ParametersValueFileInfo: object

A file containing a set of parameter values for an ARM template.

Optional fileName

fileName: undefined | string

File name.

Optional parametersValueInfo

parametersValueInfo: any

Contents of the file.

serializedName

serializedName: string = "ParametersValueFileInfo"

type

type: object

className

className: string = "ParametersValueFileInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fileName

fileName: object

serializedName

serializedName: string = "fileName"

type

type: object

name

name: "String" = "String"

parametersValueInfo

parametersValueInfo: object

serializedName

serializedName: string = "parametersValueInfo"

type

type: object

name

name: "Object" = "Object"

Const PercentageCostThresholdProperties

PercentageCostThresholdProperties: object

Properties of a percentage cost threshold.

Optional thresholdValue

thresholdValue: undefined | number

The cost threshold value.

serializedName

serializedName: string = "PercentageCostThresholdProperties"

type

type: object

className

className: string = "PercentageCostThresholdProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

thresholdValue

thresholdValue: object

serializedName

serializedName: string = "thresholdValue"

type

type: object

name

name: "Number" = "Number"

Const Policy

Policy: object

A Policy.

Optional createdDate

createdDate: Date

The creation date of the policy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

The description of the policy.

Optional evaluatorType

evaluatorType: PolicyEvaluatorType

The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). Possible values include: 'AllowedValuesPolicy', 'MaxValuePolicy'

Optional factData

factData: undefined | string

The fact data of the policy.

Optional factName

factName: PolicyFactName

The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. Possible values include: 'UserOwnedLabVmCount', 'UserOwnedLabPremiumVmCount', 'LabVmCount', 'LabPremiumVmCount', 'LabVmSize', 'GalleryImage', 'UserOwnedLabVmCountInSubnet', 'LabTargetCost', 'EnvironmentTemplate', 'ScheduleEditPermission'

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: PolicyStatus

The status of the policy. Possible values include: 'Enabled', 'Disabled'

Optional tags

tags: undefined | object

The tags of the resource.

Optional threshold

threshold: undefined | string

The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Policy"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Policy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

evaluatorType

evaluatorType: object

serializedName

serializedName: string = "properties.evaluatorType"

type

type: object

name

name: "String" = "String"

factData

factData: object

serializedName

serializedName: string = "properties.factData"

type

type: object

name

name: "String" = "String"

factName

factName: object

serializedName

serializedName: string = "properties.factName"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

threshold

threshold: object

serializedName

serializedName: string = "properties.threshold"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

Const PolicyFragment

PolicyFragment: object

A Policy.

Optional description

description: undefined | string

The description of the policy.

Optional evaluatorType

evaluatorType: PolicyEvaluatorType

The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). Possible values include: 'AllowedValuesPolicy', 'MaxValuePolicy'

Optional factData

factData: undefined | string

The fact data of the policy.

Optional factName

factName: PolicyFactName

The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. Possible values include: 'UserOwnedLabVmCount', 'UserOwnedLabPremiumVmCount', 'LabVmCount', 'LabPremiumVmCount', 'LabVmSize', 'GalleryImage', 'UserOwnedLabVmCountInSubnet', 'LabTargetCost', 'EnvironmentTemplate', 'ScheduleEditPermission'

Optional status

status: PolicyStatus

The status of the policy. Possible values include: 'Enabled', 'Disabled'

Optional tags

tags: undefined | object

The tags of the resource.

Optional threshold

threshold: undefined | string

The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).

serializedName

serializedName: string = "PolicyFragment"

type

type: object

className

className: string = "PolicyFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

evaluatorType

evaluatorType: object

serializedName

serializedName: string = "properties.evaluatorType"

type

type: object

name

name: "String" = "String"

factData

factData: object

serializedName

serializedName: string = "properties.factData"

type

type: object

name

name: "String" = "String"

factName

factName: object

serializedName

serializedName: string = "properties.factName"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

threshold

threshold: object

serializedName

serializedName: string = "properties.threshold"

type

type: object

name

name: "String" = "String"

Const PolicyList

PolicyList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "PolicyList"

__@iterator

  • __@iterator(): IterableIterator<Policy>
  • Iterator

    Returns IterableIterator<Policy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Policy>[]): Policy[]
  • concat(...items: (T | ConcatArray<T>)[]): Policy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Policy>[]

      Additional items to add to the end of array1.

    Returns Policy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Policy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Policy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Policy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Policy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Policy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Policy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Policy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Policy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Policy, index: number, obj: Policy[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Policy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Policy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Policy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Policy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Policy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Policy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Policy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Policy | undefined

push

  • push(...items: Policy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Policy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Policy
  • reduce(callbackfn: function, initialValue: Policy): Policy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Policy

  • Parameters

    Returns Policy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Policy, currentIndex: number, array: Policy[]): U
        • Parameters

          • previousValue: U
          • currentValue: Policy
          • currentIndex: number
          • array: Policy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Policy
  • reduceRight(callbackfn: function, initialValue: Policy): Policy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Policy

  • Parameters

    Returns Policy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Policy, currentIndex: number, array: Policy[]): U
        • Parameters

          • previousValue: U
          • currentValue: Policy
          • currentIndex: number
          • array: Policy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Policy[]

shift

  • Removes the first element from an array and returns it.

    Returns Policy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Policy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Policy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Policy[]
  • splice(start: number, deleteCount: number, ...items: Policy[]): Policy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Policy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Policy[]

      Elements to insert into the array in place of the deleted elements.

    Returns Policy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Policy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Policy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Policy>
  • Returns an iterable of values in the array

    Returns IterableIterator<Policy>

type

type: object

className

className: string = "PolicyList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Policy"

name

name: "Composite" = "Composite"

Const PolicySetResult

PolicySetResult: object

Result of a policy set evaluation.

Optional hasError

hasError: undefined | false | true

A value indicating whether this policy set evaluation has discovered violations.

Optional policyViolations

policyViolations: PolicyViolation[]

The list of policy violations.

serializedName

serializedName: string = "PolicySetResult"

type

type: object

className

className: string = "PolicySetResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hasError

hasError: object

serializedName

serializedName: string = "hasError"

type

type: object

name

name: "Boolean" = "Boolean"

policyViolations

policyViolations: object

serializedName

serializedName: string = "policyViolations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PolicyViolation"

name

name: "Composite" = "Composite"

Const PolicyViolation

PolicyViolation: object

Policy violation.

Optional code

code: undefined | string

The code of the policy violation.

Optional message

message: undefined | string

The message of the policy violation.

serializedName

serializedName: string = "PolicyViolation"

type

type: object

className

className: string = "PolicyViolation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const Port

Port: object

Properties of a network port.

Optional backendPort

backendPort: undefined | number

Backend port of the target virtual machine.

Optional transportProtocol

transportProtocol: TransportProtocol

Protocol type of the port. Possible values include: 'Tcp', 'Udp'

serializedName

serializedName: string = "Port"

type

type: object

className

className: string = "Port"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendPort

backendPort: object

serializedName

serializedName: string = "backendPort"

type

type: object

name

name: "Number" = "Number"

transportProtocol

transportProtocol: object

serializedName

serializedName: string = "transportProtocol"

type

type: object

name

name: "String" = "String"

Const PortFragment

PortFragment: object

Properties of a network port.

Optional backendPort

backendPort: undefined | number

Backend port of the target virtual machine.

Optional transportProtocol

transportProtocol: TransportProtocol

Protocol type of the port. Possible values include: 'Tcp', 'Udp'

serializedName

serializedName: string = "PortFragment"

type

type: object

className

className: string = "PortFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendPort

backendPort: object

serializedName

serializedName: string = "backendPort"

type

type: object

name

name: "Number" = "Number"

transportProtocol

transportProtocol: object

serializedName

serializedName: string = "transportProtocol"

type

type: object

name

name: "String" = "String"

Const ProviderOperationResult

ProviderOperationResult: object
interface

Result of the request to list REST API operations

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProviderOperationResult"

__@iterator

  • Iterator

    Returns IterableIterator<OperationMetadata>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<OperationMetadata>[]

      Additional items to add to the end of array1.

    Returns OperationMetadata[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns OperationMetadata[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, OperationMetadata]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: OperationMetadata, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: OperationMetadata

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): OperationMetadata[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns OperationMetadata[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): OperationMetadata | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns OperationMetadata | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: OperationMetadata, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: OperationMetadata

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: OperationMetadata

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: OperationMetadata, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: OperationMetadata

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns OperationMetadata | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns OperationMetadata

  • Parameters

    Returns OperationMetadata

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns OperationMetadata

  • Parameters

    Returns OperationMetadata

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns OperationMetadata[]

shift

  • Removes the first element from an array and returns it.

    Returns OperationMetadata | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns OperationMetadata[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns OperationMetadata[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: OperationMetadata[]

      Elements to insert into the array in place of the deleted elements.

    Returns OperationMetadata[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<OperationMetadata>

type

type: object

className

className: string = "ProviderOperationResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationMetadata"

name

name: "Composite" = "Composite"

Const RdpConnection

RdpConnection: object

Represents a .rdp file

Optional contents

contents: undefined | string

The contents of the .rdp file

serializedName

serializedName: string = "RdpConnection"

type

type: object

className

className: string = "RdpConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contents

contents: object

serializedName

serializedName: string = "contents"

type

type: object

name

name: "String" = "String"

Const ResizeLabVirtualMachineProperties

ResizeLabVirtualMachineProperties: object

Request body for resizing a virtual machine.

Optional size

size: undefined | string

Specifies the size of the virtual machine.

serializedName

serializedName: string = "ResizeLabVirtualMachineProperties"

type

type: object

className

className: string = "ResizeLabVirtualMachineProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

size

size: object

serializedName

serializedName: string = "size"

type

type: object

name

name: "String" = "String"

Const Resource

Resource: object

An Azure resource.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "Resource"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const RetargetScheduleProperties

RetargetScheduleProperties: object

Properties for retargeting a virtual machine schedule.

Optional currentResourceId

currentResourceId: undefined | string

The resource Id of the virtual machine on which the schedule operates

Optional targetResourceId

targetResourceId: undefined | string

The resource Id of the virtual machine that the schedule should be retargeted to

serializedName

serializedName: string = "RetargetScheduleProperties"

type

type: object

className

className: string = "RetargetScheduleProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentResourceId

currentResourceId: object

serializedName

serializedName: string = "currentResourceId"

type

type: object

name

name: "String" = "String"

targetResourceId

targetResourceId: object

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: "String" = "String"

Const Schedule

Schedule: object

A schedule.

Optional createdDate

createdDate: Date

The creation date of the schedule. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dailyRecurrence

dailyRecurrence: DayDetails

If the schedule will occur once each day of the week, specify the daily recurrence.

Optional hourlyRecurrence

hourlyRecurrence: HourDetails

If the schedule will occur multiple times a day, specify the hourly recurrence.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional notificationSettings

notificationSettings: NotificationSettings

Notification settings.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: EnableStatus

The status of the schedule (i.e. Enabled, Disabled). Possible values include: 'Enabled', 'Disabled'

Optional tags

tags: undefined | object

The tags of the resource.

Optional targetResourceId

targetResourceId: undefined | string

The resource ID to which the schedule belongs

Optional taskType

taskType: undefined | string

The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).

Optional timeZoneId

timeZoneId: undefined | string

The time zone ID (e.g. Pacific Standard time).

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

Optional weeklyRecurrence

weeklyRecurrence: WeekDetails

If the schedule will occur only some days of the week, specify the weekly recurrence.

serializedName

serializedName: string = "Schedule"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

dailyRecurrence

dailyRecurrence: object

serializedName

serializedName: string = "properties.dailyRecurrence"

type

type: object

className

className: string = "DayDetails"

name

name: "Composite" = "Composite"

hourlyRecurrence

hourlyRecurrence: object

serializedName

serializedName: string = "properties.hourlyRecurrence"

type

type: object

className

className: string = "HourDetails"

name

name: "Composite" = "Composite"

notificationSettings

notificationSettings: object

serializedName

serializedName: string = "properties.notificationSettings"

type

type: object

className

className: string = "NotificationSettings"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

targetResourceId

targetResourceId: object

serializedName

serializedName: string = "properties.targetResourceId"

type

type: object

name

name: "String" = "String"

taskType

taskType: object

serializedName

serializedName: string = "properties.taskType"

type

type: object

name

name: "String" = "String"

timeZoneId

timeZoneId: object

serializedName

serializedName: string = "properties.timeZoneId"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

weeklyRecurrence

weeklyRecurrence: object

serializedName

serializedName: string = "properties.weeklyRecurrence"

type

type: object

className

className: string = "WeekDetails"

name

name: "Composite" = "Composite"

Const ScheduleCreationParameter

ScheduleCreationParameter: object

Properties for creating a schedule.

Optional dailyRecurrence

dailyRecurrence: DayDetails

If the schedule will occur once each day of the week, specify the daily recurrence.

Optional hourlyRecurrence

hourlyRecurrence: HourDetails

If the schedule will occur multiple times a day, specify the hourly recurrence.

Optional location

location: undefined | string

The location of the new virtual machine or environment

Optional name

name: undefined | string

The name of the virtual machine or environment

Optional notificationSettings

notificationSettings: NotificationSettings

Notification settings.

Optional status

status: EnableStatus

The status of the schedule (i.e. Enabled, Disabled). Possible values include: 'Enabled', 'Disabled'

Optional tags

tags: undefined | object

The tags of the resource.

Optional targetResourceId

targetResourceId: undefined | string

The resource ID to which the schedule belongs

Optional taskType

taskType: undefined | string

The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).

Optional timeZoneId

timeZoneId: undefined | string

The time zone ID (e.g. Pacific Standard time).

Optional weeklyRecurrence

weeklyRecurrence: WeekDetails

If the schedule will occur only some days of the week, specify the weekly recurrence.

serializedName

serializedName: string = "ScheduleCreationParameter"

type

type: object

className

className: string = "ScheduleCreationParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dailyRecurrence

dailyRecurrence: object

serializedName

serializedName: string = "properties.dailyRecurrence"

type

type: object

className

className: string = "DayDetails"

name

name: "Composite" = "Composite"

hourlyRecurrence

hourlyRecurrence: object

serializedName

serializedName: string = "properties.hourlyRecurrence"

type

type: object

className

className: string = "HourDetails"

name

name: "Composite" = "Composite"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

notificationSettings

notificationSettings: object

serializedName

serializedName: string = "properties.notificationSettings"

type

type: object

className

className: string = "NotificationSettings"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

targetResourceId

targetResourceId: object

serializedName

serializedName: string = "properties.targetResourceId"

type

type: object

name

name: "String" = "String"

taskType

taskType: object

serializedName

serializedName: string = "properties.taskType"

type

type: object

name

name: "String" = "String"

timeZoneId

timeZoneId: object

serializedName

serializedName: string = "properties.timeZoneId"

type

type: object

name

name: "String" = "String"

weeklyRecurrence

weeklyRecurrence: object

serializedName

serializedName: string = "properties.weeklyRecurrence"

type

type: object

className

className: string = "WeekDetails"

name

name: "Composite" = "Composite"

Const ScheduleCreationParameterFragment

ScheduleCreationParameterFragment: object

Properties for creating a schedule.

Optional dailyRecurrence

dailyRecurrence: DayDetailsFragment

If the schedule will occur once each day of the week, specify the daily recurrence.

Optional hourlyRecurrence

hourlyRecurrence: HourDetailsFragment

If the schedule will occur multiple times a day, specify the hourly recurrence.

Optional location

location: undefined | string

The location of the new virtual machine or environment

Optional name

name: undefined | string

The name of the virtual machine or environment

Optional notificationSettings

notificationSettings: NotificationSettingsFragment

Notification settings.

Optional status

status: EnableStatus

The status of the schedule (i.e. Enabled, Disabled). Possible values include: 'Enabled', 'Disabled'

Optional tags

tags: undefined | object

The tags of the resource.

Optional targetResourceId

targetResourceId: undefined | string

The resource ID to which the schedule belongs

Optional taskType

taskType: undefined | string

The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).

Optional timeZoneId

timeZoneId: undefined | string

The time zone ID (e.g. Pacific Standard time).

Optional weeklyRecurrence

weeklyRecurrence: WeekDetailsFragment

If the schedule will occur only some days of the week, specify the weekly recurrence.

serializedName

serializedName: string = "ScheduleCreationParameterFragment"

type

type: object

className

className: string = "ScheduleCreationParameterFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dailyRecurrence

dailyRecurrence: object

serializedName

serializedName: string = "properties.dailyRecurrence"

type

type: object

className

className: string = "DayDetailsFragment"

name

name: "Composite" = "Composite"

hourlyRecurrence

hourlyRecurrence: object

serializedName

serializedName: string = "properties.hourlyRecurrence"

type

type: object

className

className: string = "HourDetailsFragment"

name

name: "Composite" = "Composite"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

notificationSettings

notificationSettings: object

serializedName

serializedName: string = "properties.notificationSettings"

type

type: object

className

className: string = "NotificationSettingsFragment"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

targetResourceId

targetResourceId: object

serializedName

serializedName: string = "properties.targetResourceId"

type

type: object

name

name: "String" = "String"

taskType

taskType: object

serializedName

serializedName: string = "properties.taskType"

type

type: object

name

name: "String" = "String"

timeZoneId

timeZoneId: object

serializedName

serializedName: string = "properties.timeZoneId"

type

type: object

name

name: "String" = "String"

weeklyRecurrence

weeklyRecurrence: object

serializedName

serializedName: string = "properties.weeklyRecurrence"

type

type: object

className

className: string = "WeekDetailsFragment"

name

name: "Composite" = "Composite"

Const ScheduleFragment

ScheduleFragment: object

A schedule.

Optional dailyRecurrence

dailyRecurrence: DayDetailsFragment

If the schedule will occur once each day of the week, specify the daily recurrence.

Optional hourlyRecurrence

hourlyRecurrence: HourDetailsFragment

If the schedule will occur multiple times a day, specify the hourly recurrence.

Optional notificationSettings

notificationSettings: NotificationSettingsFragment

Notification settings.

Optional status

status: EnableStatus

The status of the schedule (i.e. Enabled, Disabled). Possible values include: 'Enabled', 'Disabled'

Optional tags

tags: undefined | object

The tags of the resource.

Optional targetResourceId

targetResourceId: undefined | string

The resource ID to which the schedule belongs

Optional taskType

taskType: undefined | string

The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).

Optional timeZoneId

timeZoneId: undefined | string

The time zone ID (e.g. Pacific Standard time).

Optional weeklyRecurrence

weeklyRecurrence: WeekDetailsFragment

If the schedule will occur only some days of the week, specify the weekly recurrence.

serializedName

serializedName: string = "ScheduleFragment"

type

type: object

className

className: string = "ScheduleFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dailyRecurrence

dailyRecurrence: object

serializedName

serializedName: string = "properties.dailyRecurrence"

type

type: object

className

className: string = "DayDetailsFragment"

name

name: "Composite" = "Composite"

hourlyRecurrence

hourlyRecurrence: object

serializedName

serializedName: string = "properties.hourlyRecurrence"

type

type: object

className

className: string = "HourDetailsFragment"

name

name: "Composite" = "Composite"

notificationSettings

notificationSettings: object

serializedName

serializedName: string = "properties.notificationSettings"

type

type: object

className

className: string = "NotificationSettingsFragment"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

targetResourceId

targetResourceId: object

serializedName

serializedName: string = "properties.targetResourceId"

type

type: object

name

name: "String" = "String"

taskType

taskType: object

serializedName

serializedName: string = "properties.taskType"

type

type: object

name

name: "String" = "String"

timeZoneId

timeZoneId: object

serializedName

serializedName: string = "properties.timeZoneId"

type

type: object

name

name: "String" = "String"

weeklyRecurrence

weeklyRecurrence: object

serializedName

serializedName: string = "properties.weeklyRecurrence"

type

type: object

className

className: string = "WeekDetailsFragment"

name

name: "Composite" = "Composite"

Const ScheduleList

ScheduleList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "ScheduleList"

__@iterator

  • __@iterator(): IterableIterator<Schedule>
  • Iterator

    Returns IterableIterator<Schedule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Schedule>[]

      Additional items to add to the end of array1.

    Returns Schedule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Schedule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Schedule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Schedule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Schedule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Schedule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Schedule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Schedule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Schedule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Schedule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Schedule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Schedule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Schedule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Schedule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Schedule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Schedule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Schedule | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Schedule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Schedule
  • reduce(callbackfn: function, initialValue: Schedule): Schedule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Schedule

  • Parameters

    Returns Schedule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Schedule, currentIndex: number, array: Schedule[]): U
        • Parameters

          • previousValue: U
          • currentValue: Schedule
          • currentIndex: number
          • array: Schedule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Schedule
  • reduceRight(callbackfn: function, initialValue: Schedule): Schedule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Schedule

  • Parameters

    Returns Schedule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Schedule, currentIndex: number, array: Schedule[]): U
        • Parameters

          • previousValue: U
          • currentValue: Schedule
          • currentIndex: number
          • array: Schedule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Schedule[]

shift

  • Removes the first element from an array and returns it.

    Returns Schedule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Schedule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Schedule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Schedule[]
  • splice(start: number, deleteCount: number, ...items: Schedule[]): Schedule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Schedule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Schedule[]

      Elements to insert into the array in place of the deleted elements.

    Returns Schedule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Schedule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Schedule>

type

type: object

className

className: string = "ScheduleList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

Const Secret

Secret: object

A secret.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

Optional value

value: undefined | string

The value of the secret for secret creation.

serializedName

serializedName: string = "Secret"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Secret"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "properties.value"

type

type: object

name

name: "String" = "String"

Const SecretFragment

SecretFragment: object

A secret.

Optional tags

tags: undefined | object

The tags of the resource.

Optional value

value: undefined | string

The value of the secret for secret creation.

serializedName

serializedName: string = "SecretFragment"

type

type: object

className

className: string = "SecretFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "properties.value"

type

type: object

name

name: "String" = "String"

Const SecretList

SecretList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "SecretList"

__@iterator

  • __@iterator(): IterableIterator<Secret>
  • Iterator

    Returns IterableIterator<Secret>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Secret>[]): Secret[]
  • concat(...items: (T | ConcatArray<T>)[]): Secret[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Secret>[]

      Additional items to add to the end of array1.

    Returns Secret[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Secret[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Secret]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Secret]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Secret, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Secret

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Secret[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Secret[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Secret | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Secret, index: number, obj: Secret[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Secret | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Secret, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Secret

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Secret, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Secret

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Secret, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Secret

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Secret | undefined

push

  • push(...items: Secret[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Secret[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Secret
  • reduce(callbackfn: function, initialValue: Secret): Secret
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Secret

  • Parameters

    Returns Secret

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Secret, currentIndex: number, array: Secret[]): U
        • Parameters

          • previousValue: U
          • currentValue: Secret
          • currentIndex: number
          • array: Secret[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Secret
  • reduceRight(callbackfn: function, initialValue: Secret): Secret
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Secret

  • Parameters

    Returns Secret

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Secret, currentIndex: number, array: Secret[]): U
        • Parameters

          • previousValue: U
          • currentValue: Secret
          • currentIndex: number
          • array: Secret[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Secret[]

shift

  • Removes the first element from an array and returns it.

    Returns Secret | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Secret[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Secret[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Secret[]
  • splice(start: number, deleteCount: number, ...items: Secret[]): Secret[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Secret[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Secret[]

      Elements to insert into the array in place of the deleted elements.

    Returns Secret[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Secret[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Secret[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Secret>
  • Returns an iterable of values in the array

    Returns IterableIterator<Secret>

type

type: object

className

className: string = "SecretList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Secret"

name

name: "Composite" = "Composite"

Const ServiceFabric

ServiceFabric: object

A Service Fabric.

Optional applicableSchedule

applicableSchedule: ApplicableSchedule

The applicable schedule for the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

Optional environmentId

environmentId: undefined | string

The resource id of the environment under which the service fabric resource is present

Optional externalServiceFabricId

externalServiceFabricId: undefined | string

The backing service fabric resource's id

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceFabric"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ServiceFabric"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicableSchedule

applicableSchedule: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.applicableSchedule"

type

type: object

className

className: string = "ApplicableSchedule"

name

name: "Composite" = "Composite"

environmentId

environmentId: object

serializedName

serializedName: string = "properties.environmentId"

type

type: object

name

name: "String" = "String"

externalServiceFabricId

externalServiceFabricId: object

serializedName

serializedName: string = "properties.externalServiceFabricId"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

Const ServiceFabricFragment

ServiceFabricFragment: object

A Service Fabric.

Optional environmentId

environmentId: undefined | string

The resource id of the environment under which the service fabric resource is present

Optional externalServiceFabricId

externalServiceFabricId: undefined | string

The backing service fabric resource's id

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "ServiceFabricFragment"

type

type: object

className

className: string = "ServiceFabricFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

environmentId

environmentId: object

serializedName

serializedName: string = "properties.environmentId"

type

type: object

name

name: "String" = "String"

externalServiceFabricId

externalServiceFabricId: object

serializedName

serializedName: string = "properties.externalServiceFabricId"

type

type: object

name

name: "String" = "String"

Const ServiceFabricList

ServiceFabricList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "ServiceFabricList"

__@iterator

  • Iterator

    Returns IterableIterator<ServiceFabric>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServiceFabric>[]

      Additional items to add to the end of array1.

    Returns ServiceFabric[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServiceFabric[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServiceFabric]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServiceFabric, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServiceFabric

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServiceFabric[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServiceFabric[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServiceFabric | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ServiceFabric | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServiceFabric, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServiceFabric

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServiceFabric, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServiceFabric

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServiceFabric, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServiceFabric

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ServiceFabric | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ServiceFabric

  • Parameters

    Returns ServiceFabric

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ServiceFabric

  • Parameters

    Returns ServiceFabric

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ServiceFabric[]

shift

  • Removes the first element from an array and returns it.

    Returns ServiceFabric | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServiceFabric[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServiceFabric[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServiceFabric[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServiceFabric[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServiceFabric[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServiceFabric[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ServiceFabric>

type

type: object

className

className: string = "ServiceFabricList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceFabric"

name

name: "Composite" = "Composite"

Const ServiceRunner

ServiceRunner: object

A container for a managed identity to execute DevTest lab services.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

The identity of the resource.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "ServiceRunner"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ServiceRunner"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "IdentityProperties"

name

name: "Composite" = "Composite"

Const ServiceRunnerList

ServiceRunnerList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "ServiceRunnerList"

__@iterator

  • Iterator

    Returns IterableIterator<ServiceRunner>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServiceRunner>[]

      Additional items to add to the end of array1.

    Returns ServiceRunner[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServiceRunner[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServiceRunner]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServiceRunner, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServiceRunner

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServiceRunner[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServiceRunner[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServiceRunner | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ServiceRunner | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServiceRunner, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServiceRunner

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServiceRunner, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServiceRunner

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServiceRunner, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServiceRunner

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ServiceRunner | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ServiceRunner

  • Parameters

    Returns ServiceRunner

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ServiceRunner

  • Parameters

    Returns ServiceRunner

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ServiceRunner[]

shift

  • Removes the first element from an array and returns it.

    Returns ServiceRunner | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServiceRunner[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServiceRunner[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServiceRunner[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServiceRunner[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServiceRunner[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServiceRunner[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ServiceRunner>

type

type: object

className

className: string = "ServiceRunnerList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceRunner"

name

name: "Composite" = "Composite"

Const SharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration: object

Properties of a virtual machine that determine how it is connected to a load balancer.

Optional inboundNatRules

inboundNatRules: InboundNatRule[]

The incoming NAT rules

serializedName

serializedName: string = "SharedPublicIpAddressConfiguration"

type

type: object

className

className: string = "SharedPublicIpAddressConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

inboundNatRules

inboundNatRules: object

serializedName

serializedName: string = "inboundNatRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNatRule"

name

name: "Composite" = "Composite"

Const SharedPublicIpAddressConfigurationFragment

SharedPublicIpAddressConfigurationFragment: object

Properties of a virtual machine that determine how it is connected to a load balancer.

Optional inboundNatRules

inboundNatRules: InboundNatRuleFragment[]

The incoming NAT rules

serializedName

serializedName: string = "SharedPublicIpAddressConfigurationFragment"

type

type: object

className

className: string = "SharedPublicIpAddressConfigurationFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

inboundNatRules

inboundNatRules: object

serializedName

serializedName: string = "inboundNatRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNatRuleFragment"

name

name: "Composite" = "Composite"

Const ShutdownNotificationContent

ShutdownNotificationContent: object

The contents of a shutdown notification. Webhooks can use this type to deserialize the request body when they get notified of an imminent shutdown.

Optional delayUrl120

delayUrl120: undefined | string

The URL to delay shutdown by 2 hours.

Optional delayUrl60

delayUrl60: undefined | string

The URL to delay shutdown by 60 minutes.

Optional eventType

eventType: undefined | string

The event for which a notification will be sent.

Optional guid

guid: undefined | string

The GUID for the virtual machine to be shut down.

Optional labName

labName: undefined | string

The lab for the schedule.

Optional minutesUntilShutdown

minutesUntilShutdown: undefined | string

Minutes remaining until shutdown

Optional owner

owner: undefined | string

The owner of the virtual machine.

Optional resourceGroupName

resourceGroupName: undefined | string

The resource group name for the schedule.

Optional skipUrl

skipUrl: undefined | string

The URL to skip auto-shutdown.

Optional subscriptionId

subscriptionId: undefined | string

The subscription ID for the schedule.

Optional text

text: undefined | string

The text for the notification.

Optional vmName

vmName: undefined | string

The virtual machine to be shut down.

Optional vmUrl

vmUrl: undefined | string

The URL of the virtual machine.

serializedName

serializedName: string = "ShutdownNotificationContent"

type

type: object

className

className: string = "ShutdownNotificationContent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

delayUrl120

delayUrl120: object

serializedName

serializedName: string = "delayUrl120"

type

type: object

name

name: "String" = "String"

delayUrl60

delayUrl60: object

serializedName

serializedName: string = "delayUrl60"

type

type: object

name

name: "String" = "String"

eventType

eventType: object

serializedName

serializedName: string = "eventType"

type

type: object

name

name: "String" = "String"

guid

guid: object

serializedName

serializedName: string = "guid"

type

type: object

name

name: "String" = "String"

labName

labName: object

serializedName

serializedName: string = "labName"

type

type: object

name

name: "String" = "String"

minutesUntilShutdown

minutesUntilShutdown: object

serializedName

serializedName: string = "minutesUntilShutdown"

type

type: object

name

name: "String" = "String"

owner

owner: object

serializedName

serializedName: string = "owner"

type

type: object

name

name: "String" = "String"

resourceGroupName

resourceGroupName: object

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

skipUrl

skipUrl: object

serializedName

serializedName: string = "skipUrl"

type

type: object

name

name: "String" = "String"

subscriptionId

subscriptionId: object

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

text

text: object

serializedName

serializedName: string = "text"

type

type: object

name

name: "String" = "String"

vmName

vmName: object

serializedName

serializedName: string = "vmName"

type

type: object

name

name: "String" = "String"

vmUrl

vmUrl: object

serializedName

serializedName: string = "vmUrl"

type

type: object

name

name: "String" = "String"

Const Subnet

Subnet: object

Subnet information.

Optional allowPublicIp

allowPublicIp: UsagePermissionType

The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). Possible values include: 'Default', 'Deny', 'Allow'

Optional labSubnetName

labSubnetName: undefined | string

The name of the subnet as seen in the lab.

Optional resourceId

resourceId: undefined | string

The resource ID of the subnet.

serializedName

serializedName: string = "Subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowPublicIp

allowPublicIp: object

serializedName

serializedName: string = "allowPublicIp"

type

type: object

name

name: "String" = "String"

labSubnetName

labSubnetName: object

serializedName

serializedName: string = "labSubnetName"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

Const SubnetFragment

SubnetFragment: object

Subnet information.

Optional allowPublicIp

allowPublicIp: UsagePermissionType

The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). Possible values include: 'Default', 'Deny', 'Allow'

Optional labSubnetName

labSubnetName: undefined | string

The name of the subnet as seen in the lab.

Optional resourceId

resourceId: undefined | string

The resource ID of the subnet.

serializedName

serializedName: string = "SubnetFragment"

type

type: object

className

className: string = "SubnetFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowPublicIp

allowPublicIp: object

serializedName

serializedName: string = "allowPublicIp"

type

type: object

name

name: "String" = "String"

labSubnetName

labSubnetName: object

serializedName

serializedName: string = "labSubnetName"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

Const SubnetOverride

SubnetOverride: object

Property overrides on a subnet of a virtual network.

Optional labSubnetName

labSubnetName: undefined | string

The name given to the subnet within the lab.

Optional resourceId

resourceId: undefined | string

The resource ID of the subnet.

Optional sharedPublicIpAddressConfiguration

sharedPublicIpAddressConfiguration: SubnetSharedPublicIpAddressConfiguration

Properties that virtual machines on this subnet will share.

Optional useInVmCreationPermission

useInVmCreationPermission: UsagePermissionType

Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). Possible values include: 'Default', 'Deny', 'Allow'

Optional usePublicIpAddressPermission

usePublicIpAddressPermission: UsagePermissionType

Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). Possible values include: 'Default', 'Deny', 'Allow'

Optional virtualNetworkPoolName

virtualNetworkPoolName: undefined | string

The virtual network pool associated with this subnet.

serializedName

serializedName: string = "SubnetOverride"

type

type: object

className

className: string = "SubnetOverride"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

labSubnetName

labSubnetName: object

serializedName

serializedName: string = "labSubnetName"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

sharedPublicIpAddressConfiguration

sharedPublicIpAddressConfiguration: object

serializedName

serializedName: string = "sharedPublicIpAddressConfiguration"

type

type: object

className

className: string = "SubnetSharedPublicIpAddressConfiguration"

name

name: "Composite" = "Composite"

useInVmCreationPermission

useInVmCreationPermission: object

serializedName

serializedName: string = "useInVmCreationPermission"

type

type: object

name

name: "String" = "String"

usePublicIpAddressPermission

usePublicIpAddressPermission: object

serializedName

serializedName: string = "usePublicIpAddressPermission"

type

type: object

name

name: "String" = "String"

virtualNetworkPoolName

virtualNetworkPoolName: object

serializedName

serializedName: string = "virtualNetworkPoolName"

type

type: object

name

name: "String" = "String"

Const SubnetOverrideFragment

SubnetOverrideFragment: object

Property overrides on a subnet of a virtual network.

Optional labSubnetName

labSubnetName: undefined | string

The name given to the subnet within the lab.

Optional resourceId

resourceId: undefined | string

The resource ID of the subnet.

Optional sharedPublicIpAddressConfiguration

sharedPublicIpAddressConfiguration: SubnetSharedPublicIpAddressConfigurationFragment

Properties that virtual machines on this subnet will share.

Optional useInVmCreationPermission

useInVmCreationPermission: UsagePermissionType

Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). Possible values include: 'Default', 'Deny', 'Allow'

Optional usePublicIpAddressPermission

usePublicIpAddressPermission: UsagePermissionType

Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). Possible values include: 'Default', 'Deny', 'Allow'

Optional virtualNetworkPoolName

virtualNetworkPoolName: undefined | string

The virtual network pool associated with this subnet.

serializedName

serializedName: string = "SubnetOverrideFragment"

type

type: object

className

className: string = "SubnetOverrideFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

labSubnetName

labSubnetName: object

serializedName

serializedName: string = "labSubnetName"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

sharedPublicIpAddressConfiguration

sharedPublicIpAddressConfiguration: object

serializedName

serializedName: string = "sharedPublicIpAddressConfiguration"

type

type: object

className

className: string = "SubnetSharedPublicIpAddressConfigurationFragment"

name

name: "Composite" = "Composite"

useInVmCreationPermission

useInVmCreationPermission: object

serializedName

serializedName: string = "useInVmCreationPermission"

type

type: object

name

name: "String" = "String"

usePublicIpAddressPermission

usePublicIpAddressPermission: object

serializedName

serializedName: string = "usePublicIpAddressPermission"

type

type: object

name

name: "String" = "String"

virtualNetworkPoolName

virtualNetworkPoolName: object

serializedName

serializedName: string = "virtualNetworkPoolName"

type

type: object

name

name: "String" = "String"

Const SubnetSharedPublicIpAddressConfiguration

SubnetSharedPublicIpAddressConfiguration: object

Configuration for public IP address sharing.

Optional allowedPorts

allowedPorts: Port[]

Backend ports that virtual machines on this subnet are allowed to expose

serializedName

serializedName: string = "SubnetSharedPublicIpAddressConfiguration"

type

type: object

className

className: string = "SubnetSharedPublicIpAddressConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedPorts

allowedPorts: object

serializedName

serializedName: string = "allowedPorts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Port"

name

name: "Composite" = "Composite"

Const SubnetSharedPublicIpAddressConfigurationFragment

SubnetSharedPublicIpAddressConfigurationFragment: object

Configuration for public IP address sharing.

Optional allowedPorts

allowedPorts: PortFragment[]

Backend ports that virtual machines on this subnet are allowed to expose

serializedName

serializedName: string = "SubnetSharedPublicIpAddressConfigurationFragment"

type

type: object

className

className: string = "SubnetSharedPublicIpAddressConfigurationFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedPorts

allowedPorts: object

serializedName

serializedName: string = "allowedPorts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PortFragment"

name

name: "Composite" = "Composite"

Const TargetCostProperties

TargetCostProperties: object

Properties of a cost target.

Optional costThresholds

costThresholds: CostThresholdProperties[]

Cost thresholds.

Optional cycleEndDateTime

cycleEndDateTime: Date

Reporting cycle end date.

Optional cycleStartDateTime

cycleStartDateTime: Date

Reporting cycle start date.

Optional cycleType

Reporting cycle type. Possible values include: 'CalendarMonth', 'Custom'

Optional status

Target cost status. Possible values include: 'Enabled', 'Disabled'

Optional target

target: undefined | number

Lab target cost

serializedName

serializedName: string = "TargetCostProperties"

type

type: object

className

className: string = "TargetCostProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

costThresholds

costThresholds: object

serializedName

serializedName: string = "costThresholds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CostThresholdProperties"

name

name: "Composite" = "Composite"

cycleEndDateTime

cycleEndDateTime: object

serializedName

serializedName: string = "cycleEndDateTime"

type

type: object

name

name: "DateTime" = "DateTime"

cycleStartDateTime

cycleStartDateTime: object

serializedName

serializedName: string = "cycleStartDateTime"

type

type: object

name

name: "DateTime" = "DateTime"

cycleType

cycleType: object

serializedName

serializedName: string = "cycleType"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: "Number" = "Number"

Const UpdateResource

UpdateResource: object

Represents an update resource

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "UpdateResource"

type

type: object

className

className: string = "UpdateResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const User

User: object

Profile of a lab user.

Optional createdDate

createdDate: Date

The creation date of the user profile. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

identity: UserIdentity

The identity of the user.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional secretStore

secretStore: UserSecretStore

The secret store of the user.

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "User"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "User"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

identity

identity: object

serializedName

serializedName: string = "properties.identity"

type

type: object

className

className: string = "UserIdentity"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

secretStore

secretStore: object

serializedName

serializedName: string = "properties.secretStore"

type

type: object

className

className: string = "UserSecretStore"

name

name: "Composite" = "Composite"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

Const UserFragment

UserFragment: object

Profile of a lab user.

Optional identity

The identity of the user.

Optional secretStore

The secret store of the user.

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "UserFragment"

type

type: object

className

className: string = "UserFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

identity

identity: object

serializedName

serializedName: string = "properties.identity"

type

type: object

className

className: string = "UserIdentityFragment"

name

name: "Composite" = "Composite"

secretStore

secretStore: object

serializedName

serializedName: string = "properties.secretStore"

type

type: object

className

className: string = "UserSecretStoreFragment"

name

name: "Composite" = "Composite"

Const UserIdentity

UserIdentity: object

Identity attributes of a lab user.

Optional appId

appId: undefined | string

Set to the app Id of the client JWT making the request.

Optional objectId

objectId: undefined | string

Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.

Optional principalId

principalId: undefined | string

Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.

Optional principalName

principalName: undefined | string

Set to the principal name / UPN of the client JWT making the request.

Optional tenantId

tenantId: undefined | string

Set to the tenant ID of the client JWT making the request.

serializedName

serializedName: string = "UserIdentity"

type

type: object

className

className: string = "UserIdentity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

appId

appId: object

serializedName

serializedName: string = "appId"

type

type: object

name

name: "String" = "String"

objectId

objectId: object

serializedName

serializedName: string = "objectId"

type

type: object

name

name: "String" = "String"

principalId

principalId: object

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

principalName

principalName: object

serializedName

serializedName: string = "principalName"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

Const UserIdentityFragment

UserIdentityFragment: object

Identity attributes of a lab user.

Optional appId

appId: undefined | string

Set to the app Id of the client JWT making the request.

Optional objectId

objectId: undefined | string

Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.

Optional principalId

principalId: undefined | string

Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.

Optional principalName

principalName: undefined | string

Set to the principal name / UPN of the client JWT making the request.

Optional tenantId

tenantId: undefined | string

Set to the tenant ID of the client JWT making the request.

serializedName

serializedName: string = "UserIdentityFragment"

type

type: object

className

className: string = "UserIdentityFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

appId

appId: object

serializedName

serializedName: string = "appId"

type

type: object

name

name: "String" = "String"

objectId

objectId: object

serializedName

serializedName: string = "objectId"

type

type: object

name

name: "String" = "String"

principalId

principalId: object

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

principalName

principalName: object

serializedName

serializedName: string = "principalName"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

Const UserList

UserList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "UserList"

__@iterator

  • __@iterator(): IterableIterator<User>
  • Iterator

    Returns IterableIterator<User>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<User>[]): User[]
  • concat(...items: (T | ConcatArray<T>)[]): User[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<User>[]

      Additional items to add to the end of array1.

    Returns User[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns User[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, User]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, User]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: User, index: number, array: User[]): boolean
        • Parameters

          • value: User
          • index: number
          • array: User[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: User, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: User

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): User[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: User, index: number, array: User[]): boolean
        • Parameters

          • value: User
          • index: number
          • array: User[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: User, index: number, array: User[]): any
        • Parameters

          • value: User
          • index: number
          • array: User[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns User[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): User | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: User, index: number, obj: User[]): boolean
        • Parameters

          • this: void
          • value: User
          • index: number
          • obj: User[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: User, index: number, obj: User[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns User | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: User, index: number, obj: User[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: User, index: number, array: User[]): void
        • Parameters

          • value: User
          • index: number
          • array: User[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: User, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: User

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: User, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: User

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: User, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: User

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: User, index: number, array: User[]): U
        • Parameters

          • value: User
          • index: number
          • array: User[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): User | undefined
  • Removes the last element from an array and returns it.

    Returns User | undefined

push

  • push(...items: User[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: User[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): User
  • reduce(callbackfn: function, initialValue: User): User
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: User, currentValue: User, currentIndex: number, array: User[]): User
        • Parameters

          • previousValue: User
          • currentValue: User
          • currentIndex: number
          • array: User[]

          Returns User

    Returns User

  • Parameters

    • callbackfn: function
        • (previousValue: User, currentValue: User, currentIndex: number, array: User[]): User
        • Parameters

          • previousValue: User
          • currentValue: User
          • currentIndex: number
          • array: User[]

          Returns User

    • initialValue: User

    Returns User

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: User, currentIndex: number, array: User[]): U
        • Parameters

          • previousValue: U
          • currentValue: User
          • currentIndex: number
          • array: User[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): User
  • reduceRight(callbackfn: function, initialValue: User): User
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: User, currentValue: User, currentIndex: number, array: User[]): User
        • Parameters

          • previousValue: User
          • currentValue: User
          • currentIndex: number
          • array: User[]

          Returns User

    Returns User

  • Parameters

    • callbackfn: function
        • (previousValue: User, currentValue: User, currentIndex: number, array: User[]): User
        • Parameters

          • previousValue: User
          • currentValue: User
          • currentIndex: number
          • array: User[]

          Returns User

    • initialValue: User

    Returns User

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: User, currentIndex: number, array: User[]): U
        • Parameters

          • previousValue: U
          • currentValue: User
          • currentIndex: number
          • array: User[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns User[]

shift

  • shift(): User | undefined
  • Removes the first element from an array and returns it.

    Returns User | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): User[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns User[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: User, index: number, array: User[]): boolean
        • Parameters

          • value: User
          • index: number
          • array: User[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): User[]
  • splice(start: number, deleteCount: number, ...items: User[]): User[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns User[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: User[]

      Elements to insert into the array in place of the deleted elements.

    Returns User[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: User[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: User[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<User>
  • Returns an iterable of values in the array

    Returns IterableIterator<User>

type

type: object

className

className: string = "UserList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "User"

name

name: "Composite" = "Composite"

Const UserSecretStore

UserSecretStore: object

Properties of a user's secret store.

Optional keyVaultId

keyVaultId: undefined | string

The ID of the user's Key vault.

Optional keyVaultUri

keyVaultUri: undefined | string

The URI of the user's Key vault.

serializedName

serializedName: string = "UserSecretStore"

type

type: object

className

className: string = "UserSecretStore"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyVaultId

keyVaultId: object

serializedName

serializedName: string = "keyVaultId"

type

type: object

name

name: "String" = "String"

keyVaultUri

keyVaultUri: object

serializedName

serializedName: string = "keyVaultUri"

type

type: object

name

name: "String" = "String"

Const UserSecretStoreFragment

UserSecretStoreFragment: object

Properties of a user's secret store.

Optional keyVaultId

keyVaultId: undefined | string

The ID of the user's Key vault.

Optional keyVaultUri

keyVaultUri: undefined | string

The URI of the user's Key vault.

serializedName

serializedName: string = "UserSecretStoreFragment"

type

type: object

className

className: string = "UserSecretStoreFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyVaultId

keyVaultId: object

serializedName

serializedName: string = "keyVaultId"

type

type: object

name

name: "String" = "String"

keyVaultUri

keyVaultUri: object

serializedName

serializedName: string = "keyVaultUri"

type

type: object

name

name: "String" = "String"

Const VirtualNetwork

VirtualNetwork: object

A virtual network.

Optional allowedSubnets

allowedSubnets: Subnet[]

The allowed subnets of the virtual network.

Optional createdDate

createdDate: Date

The creation date of the virtual network. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

The description of the virtual network.

Optional externalProviderResourceId

externalProviderResourceId: undefined | string

The Microsoft.Network resource identifier of the virtual network.

Optional externalSubnets

externalSubnets: ExternalSubnet[]

The external subnet properties. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The location of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subnetOverrides

subnetOverrides: SubnetOverride[]

The subnet overrides of the virtual network.

Optional tags

tags: undefined | object

The tags of the resource.

Optional uniqueIdentifier

uniqueIdentifier: undefined | string

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetwork"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "VirtualNetwork"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedSubnets

allowedSubnets: object

serializedName

serializedName: string = "properties.allowedSubnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

externalProviderResourceId

externalProviderResourceId: object

serializedName

serializedName: string = "properties.externalProviderResourceId"

type

type: object

name

name: "String" = "String"

externalSubnets

externalSubnets: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.externalSubnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExternalSubnet"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

subnetOverrides

subnetOverrides: object

serializedName

serializedName: string = "properties.subnetOverrides"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubnetOverride"

name

name: "Composite" = "Composite"

uniqueIdentifier

uniqueIdentifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.uniqueIdentifier"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkFragment

VirtualNetworkFragment: object

A virtual network.

Optional allowedSubnets

allowedSubnets: SubnetFragment[]

The allowed subnets of the virtual network.

Optional description

description: undefined | string

The description of the virtual network.

Optional externalProviderResourceId

externalProviderResourceId: undefined | string

The Microsoft.Network resource identifier of the virtual network.

Optional subnetOverrides

subnetOverrides: SubnetOverrideFragment[]

The subnet overrides of the virtual network.

Optional tags

tags: undefined | object

The tags of the resource.

serializedName

serializedName: string = "VirtualNetworkFragment"

type

type: object

className

className: string = "VirtualNetworkFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedSubnets

allowedSubnets: object

serializedName

serializedName: string = "properties.allowedSubnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubnetFragment"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

externalProviderResourceId

externalProviderResourceId: object

serializedName

serializedName: string = "properties.externalProviderResourceId"

type

type: object

name

name: "String" = "String"

subnetOverrides

subnetOverrides: object

serializedName

serializedName: string = "properties.subnetOverrides"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubnetOverrideFragment"

name

name: "Composite" = "Composite"

Const VirtualNetworkList

VirtualNetworkList: object
interface

The response of a list operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link for next set of results.

serializedName

serializedName: string = "VirtualNetworkList"

__@iterator

  • Iterator

    Returns IterableIterator<VirtualNetwork>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetwork>[]

      Additional items to add to the end of array1.

    Returns VirtualNetwork[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetwork[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetwork]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetwork, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetwork

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetwork[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetwork[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetwork | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns VirtualNetwork | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetwork, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetwork

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetwork, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetwork

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetwork, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetwork

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns VirtualNetwork | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns VirtualNetwork

  • Parameters

    Returns VirtualNetwork

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns VirtualNetwork

  • Parameters

    Returns VirtualNetwork

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns VirtualNetwork[]

shift

  • Removes the first element from an array and returns it.

    Returns VirtualNetwork | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetwork[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetwork[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetwork[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetwork[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetwork[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetwork[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetwork>

type

type: object

className

className: string = "VirtualNetworkList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetwork"

name

name: "Composite" = "Composite"

Const WeekDetails

WeekDetails: object

Properties of a weekly schedule.

Optional time

time: undefined | string

The time of the day the schedule will occur.

Optional weekdays

weekdays: string[]

The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).

serializedName

serializedName: string = "WeekDetails"

type

type: object

className

className: string = "WeekDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

time

time: object

serializedName

serializedName: string = "time"

type

type: object

name

name: "String" = "String"

weekdays

weekdays: object

serializedName

serializedName: string = "weekdays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const WeekDetailsFragment

WeekDetailsFragment: object

Properties of a weekly schedule.

Optional time

time: undefined | string

The time of the day the schedule will occur.

Optional weekdays

weekdays: string[]

The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).

serializedName

serializedName: string = "WeekDetailsFragment"

type

type: object

className

className: string = "WeekDetailsFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

time

time: object

serializedName

serializedName: string = "time"

type

type: object

name

name: "String" = "String"

weekdays

weekdays: object

serializedName

serializedName: string = "weekdays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const WindowsOsInfo

WindowsOsInfo: object

Information about a Windows OS.

Optional windowsOsState

windowsOsState: WindowsOsState

The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). Possible values include: 'NonSysprepped', 'SysprepRequested', 'SysprepApplied'

serializedName

serializedName: string = "WindowsOsInfo"

type

type: object

className

className: string = "WindowsOsInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

windowsOsState

windowsOsState: object

serializedName

serializedName: string = "windowsOsState"

type

type: object

name

name: "String" = "String"

Const WindowsOsInfoFragment

WindowsOsInfoFragment: object

Information about a Windows OS.

Optional windowsOsState

windowsOsState: WindowsOsState

The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). Possible values include: 'NonSysprepped', 'SysprepRequested', 'SysprepApplied'

serializedName

serializedName: string = "WindowsOsInfoFragment"

type

type: object

className

className: string = "WindowsOsInfoFragment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

windowsOsState

windowsOsState: object

serializedName

serializedName: string = "windowsOsState"

type

type: object

name

name: "String" = "String"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2018-09-15"

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const artifactSourceName

artifactSourceName: object

parameterPath

parameterPath: string = "artifactSourceName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "artifactSourceName"

type

type: object

name

name: "String" = "String"

Const expand

expand: object

parameterPath

parameterPath: string[] = ["options","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const filter

filter: object

parameterPath

parameterPath: string[] = ["options","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const labName

labName: object

parameterPath

parameterPath: string = "labName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "labName"

type

type: object

name

name: "String" = "String"

Const locationName

locationName: object

parameterPath

parameterPath: string = "locationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "locationName"

type

type: object

name

name: "String" = "String"

Const name

name: object

parameterPath

parameterPath: string = "name"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const orderby

orderby: object

parameterPath

parameterPath: string[] = ["options","orderby"]

mapper

mapper: object

serializedName

serializedName: string = "$orderby"

type

type: object

name

name: "String" = "String"

Const policySetName

policySetName: object

parameterPath

parameterPath: string = "policySetName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "policySetName"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const serviceFabricName

serviceFabricName: object

parameterPath

parameterPath: string = "serviceFabricName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serviceFabricName"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const top

top: object

parameterPath

parameterPath: string[] = ["options","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: "Number" = "Number"

Const userName

userName: object

parameterPath

parameterPath: string = "userName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "userName"

type

type: object

name

name: "String" = "String"

Const virtualMachineName

virtualMachineName: object

parameterPath

parameterPath: string = "virtualMachineName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualMachineName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc